Skip to content

Commit c16125a

Browse files
authored
Add documentation note about protocol specific options (#457)
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.
1 parent 8516bcd commit c16125a

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

lib/mint/http.ex

+4
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,10 @@ defmodule Mint.HTTP do
238238
server. See `Mint.HTTP2.put_settings/2` for more information. This is only used
239239
in HTTP/2 connections.
240240
241+
There may be further protocol specific options that only take effect when the corresponding
242+
connection is established. Check `Mint.HTTP1.connect/4` and `Mint.HTTP2.connect/4` for
243+
details.
244+
241245
## Protocol negotiation
242246
243247
If both `:http1` and `:http2` are present in the list passed in the `:protocols` option,

0 commit comments

Comments
 (0)