Skip to content

Commit 226c80e

Browse files
authored
Merge pull request #133 from jhrcek/docFix
Update doc comment for Affjax.request
2 parents 423ee7a + 575c839 commit 226c80e

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

Diff for: src/Affjax.purs

+5-4
Original file line numberDiff line numberDiff line change
@@ -224,14 +224,15 @@ retry policy run req = do
224224
go failureRef (n + 1)
225225
Right resp -> pure resp
226226

227-
-- | Makes an HTTP request. The first argument specifies how the HTTP response
228-
-- | body should be interpreted.
227+
-- | Makes an HTTP request.
229228
-- |
230-
-- | The example below performs a `GET` request to the URL `/resource`/ and
229+
-- | The example below performs a `GET` request to the URL `/resource` and
231230
-- | interprets the response body as JSON.
232231
-- |
233232
-- | ```purescript
234-
-- | request json (defaultRequest { url = "/resource", method = Left GET })
233+
-- | import Affjax.ResponseFormat (json)
234+
-- | ...
235+
-- | request (defaultRequest { url = "/resource", method = Left GET, responseFormat = json})
235236
-- | ```
236237
-- |
237238
-- | For common cases helper functions can often be used instead of `request` .

0 commit comments

Comments
 (0)