Commits

Bryan O'Sullivan  committed a46b657

Tidy up documentation of RetriesExceeded.

  • Participants
  • Parent commits a190444

Comments (0)

Files changed (1)

File src/Network/Riak/Resolvable/Internal.hs

     -- ^ Too many attempts were made to resolve a conflict, with each
     -- attempt resulting in another conflict.
     --
-    -- The number of retries to attempt is high (64). This makes it
-    -- extremely unlikely that this exception will be thrown during
-    -- normal application operation.  Instead, this exception is most
-    -- likely to arise as a result of a bug in your application code.
+    -- The number of retries that the library will attempt is high
+    -- (64). This makes it extremely unlikely that this exception will
+    -- be thrown during normal application operation.  Instead, this
+    -- exception is most likely to be thrown as a result of a bug in
+    -- your application code.
     --
-    -- For example, this exception may be thrown if your 'Eq' instance
-    -- is faulty, such that '==' gives false negatives.  This can
-    -- easily occur if you are storing a structure containing 'Double'
-    -- values where some are @NaN@ (the value used to represent the
-    -- expression @0/0@), because two @NaN@ values are /not/
-    -- considered equal in Haskell.
+    -- An example of such a bug could arise if your 'Eq' instance for
+    -- a type was faulty, such that '==' gave false negatives.  Such a
+    -- situation can occur if you are storing a structure containing
+    -- 'Double' values where some are @NaN@ (the value used to
+    -- represent the expression @0\/0@), because two @NaN@ values are
+    -- /not/ considered equal.
                          deriving (Eq, Show, Typeable)
 
 instance Exception ResolutionFailure