Permalink
Browse files

Tidy up documentation of RetriesExceeded.

  • Loading branch information...
1 parent 47b6d66 commit 041fb4334173c0535087360a44a3e87dbce278c8 @bos bos committed Apr 19, 2011
Showing with 11 additions and 10 deletions.
  1. +11 −10 src/Network/Riak/Resolvable/Internal.hs
@@ -45,17 +45,18 @@ data ResolutionFailure = RetriesExceeded
-- ^ 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

0 comments on commit 041fb43

Please sign in to comment.