Skip to content

Commit

Permalink
Merge pull request #133 from jhrcek/docFix
Browse files Browse the repository at this point in the history
Update doc comment for Affjax.request
  • Loading branch information
garyb committed Jan 31, 2019
2 parents 423ee7a + 575c839 commit 226c80e
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions src/Affjax.purs
Expand Up @@ -224,14 +224,15 @@ retry policy run req = do
go failureRef (n + 1)
Right resp -> pure resp

-- | Makes an HTTP request. The first argument specifies how the HTTP response
-- | body should be interpreted.
-- | Makes an HTTP request.
-- |
-- | The example below performs a `GET` request to the URL `/resource`/ and
-- | The example below performs a `GET` request to the URL `/resource` and
-- | interprets the response body as JSON.
-- |
-- | ```purescript
-- | request json (defaultRequest { url = "/resource", method = Left GET })
-- | import Affjax.ResponseFormat (json)
-- | ...
-- | request (defaultRequest { url = "/resource", method = Left GET, responseFormat = json})
-- | ```
-- |
-- | For common cases helper functions can often be used instead of `request` .
Expand Down

0 comments on commit 226c80e

Please sign in to comment.