Documenation for jsonEquality

2017-10-16 09:11:43 -07:00 · 2017-10-16 09:11:43 -07:00 · fa1a03257e
commit fa1a03257e
parent cce3bef538
1 changed files with 4 additions and 0 deletions
--- a/src/Servant/QuickCheck/Internal/Equality.hs
+++ b/src/Servant/QuickCheck/Internal/Equality.hs
@ -27,6 +27,10 @@ allEquality = ResponseEquality (==)
 bodyEquality :: Eq b => ResponseEquality b
 bodyEquality = ResponseEquality ((==) `on` responseBody)

+-- | Equality as 'Value'. This means that if two bodies are equal as JSON
+-- (e.g., insignificant whitespace difference) they are considered equal.
+--
+-- /Since 0.0.3.0/
 jsonEquality :: (JsonEq b) => ResponseEquality b
 jsonEquality = ResponseEquality (jsonEq `on` responseBody)