Skip to content

Update doc comment for Affjax.request #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 31, 2019
Merged

Update doc comment for Affjax.request #133

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions src/Affjax.purs
View file
Open in desktop
Original file line number Diff line number Diff line change
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