Skip to content
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.

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

Document transport options #80

Merged
merged 4 commits into from Feb 19, 2019
Merged

Document transport options #80

merged 4 commits into from Feb 19, 2019

Conversation

voltone
Copy link
Contributor

@voltone voltone commented Feb 14, 2019

See #79

If this is too much to document inline in Mint.HTTP.connect/3,4 then perhaps we can define a custom type for :transport_opts and move the new section to a typedoc. I imagine documenting them under Mint.Core.Transport.{TCP, SSL} instead is not desirable.

Copy link
Member

@ericmj ericmj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks really good, thank you!

We just need to add the option :timeout with the default value 30_000 that we add over the tcp and ssl options.

EDIT: It's new option being added in #78.

@ericmj ericmj mentioned this pull request Feb 15, 2019
@voltone
Copy link
Contributor Author

voltone commented Feb 15, 2019

Ok, saw you merged #78, will update this with timeout in a bit

lib/mint/http.ex Outdated Show resolved Hide resolved
lib/mint/http.ex Outdated Show resolved Hide resolved
lib/mint/http.ex Outdated Show resolved Hide resolved
lib/mint/http.ex Outdated Show resolved Hide resolved
lib/mint/http.ex Outdated Show resolved Hide resolved
lib/mint/http.ex Outdated Show resolved Hide resolved
@ericmj ericmj merged commit 774c835 into elixir-mint:master Feb 19, 2019
@ericmj
Copy link
Member

ericmj commented Feb 19, 2019

Thank you! 💜

@voltone voltone deleted the transport_options_docs branch February 19, 2019 06:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants