Skip to content

Commit

Permalink
Add documentation note about protocol specific options
Browse files Browse the repository at this point in the history
Most outside documenation (Finch, Req) links just to
`Mint.HTTP.connect/4` for documentation. That makes it somewhat
hard to find both the case insesntitive header options as well
as the not validating target options.

Not sure it's worth duplicating them there, so I figured I'd just
point to them - even if HTTP2 has no custom options as of now.

That's, of course, debatable.
  • Loading branch information
PragTob committed Nov 11, 2024
1 parent 8516bcd commit ab90dfc
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions lib/mint/http.ex
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,10 @@ defmodule Mint.HTTP do
server. See `Mint.HTTP2.put_settings/2` for more information. This is only used
in HTTP/2 connections.
There may be further protocol specific options that only take effect when the corresponding
connection is established. Check `Mint.HTTP1.connect/4` and `Mint.HTTP2.connect/4` for
details.
## Protocol negotiation
If both `:http1` and `:http2` are present in the list passed in the `:protocols` option,
Expand Down

0 comments on commit ab90dfc

Please sign in to comment.