Fix docs.

Author: tebello-thejane

src/Network/Bitcoin/BitX/Private.hs

@@ -14,9 +14,7 @@
 --
 -- Each one of the calls takes at least a 'BitXAuth' containing a previously-created API id and
 -- secret (created by 'Network.Bitcoin.BitX.Private.Auth.authGrant', or created by visiting
--- <https://bitx.co/settings#/api_keys>), and may either return a
--- useful 'record', a 'BitXError' if BitX actually returned an error, or 'Nothing' if some exception
--- occured (or if the data returned by BitX was unparseable).
+-- <https://bitx.co/settings#/api_keys>), and will return a 'BitXAPIResponse'..
 --
 -- It would probably be best to create the 'BitXAuth' record using the constructor 'mkBitXAuth' and
 -- lens setters:

src/Network/Bitcoin/BitX/Private/Withdrawal.hs

@@ -44,13 +44,13 @@ Creates a new withdrawal request.
 newWithdrawalRequest :: BitXAuth -> NewWithdrawal -> IO (BitXAPIResponse WithdrawalRequest)
 newWithdrawalRequest auth nwithd = simpleBitXPOSTAuth_ auth nwithd "withdrawals"
 
-{- | Get the status of a withdrawal request
+{- | Get the status of a withdrawal request by ID
 
 Returns the status of a particular withdrawal request.
 
 @Perm_R_Withdrawals@ permission required.-}
 
-getWithdrawalRequest :: BitXAuth -> Text -- ^ The withdrawal ID
+getWithdrawalRequest :: BitXAuth -> Text
     -> IO (BitXAPIResponse WithdrawalRequest)
 getWithdrawalRequest auth wthid = simpleBitXGetAuth_ auth $ "withdrawals/" ++ Txt.unpack wthid
 

src/Network/Bitcoin/BitX/Public.hs

@@ -13,7 +13,7 @@
 -- As a small example, to get the current selling price of bitcoin on the BitX exchange, do the following:
 --
 -- @
---{-# LANGUAGE DataKinds #-}
+--{-\# LANGUAGE DataKinds \#-}
 --
 --import Control.Lens ((^.))
 --import Network.Bitcoin.BitX (BitXAPIResponse(..), getTicker, CcyPair(..))
@@ -28,11 +28,11 @@
 --  case bitXResponse of
 --    ValidResponse tic        -> print (tic ^. BitX.ask)
 --    ErrorResponse err        ->
---        error $ "BitX error received: \"" ++ unpack (err ^. BitX.error) ++ "\""
+--        error $ "BitX error received: \\"" ++ unpack (err ^. BitX.error) ++ "\\""
 --    ExceptionResponse ex     ->
---        error $ "Exception was thrown: \"" ++ unpack ex ++ "\""
+--        error $ "Exception was thrown: \\"" ++ unpack ex ++ "\\""
 --    UnparseableResponse resp ->
---        error $ "Bad HTTP response; HTTP status code was: \"" ++ (show . statusCode . responseStatus $ resp) ++ "\""
+--        error $ "Bad HTTP response; HTTP status code was: \\"" ++ (show . statusCode . responseStatus $ resp) ++ "\\""
 -- @
 --
 -----------------------------------------------------------------------------