Skip to content

Commit

Permalink
clarify how f and follow_redirect interact
Browse files Browse the repository at this point in the history
  • Loading branch information
hannesm committed Nov 5, 2024
1 parent 2a2e1fd commit be2485e
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/http_lwt_client.mli
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ val pp_response : Format.formatter -> response -> unit
and returns the response. Each time part of the body is received,
[f acc part] is called, with [acc] being the last return value of [f]
(or [init] if it is the first time) and [part] being the body part received.
If [follow_redirect] is true (the default), and there's a redirection, [f]
is not called with the (potential) body of the redirection page.
By default, up to 5 redirects ([max_redirect]) are followed.
If [follow_redirect] is false, no redirect is followed (defaults to true).
Expand Down

0 comments on commit be2485e

Please sign in to comment.