Update initializer docs to use kwargs for name
#85
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is a more exhaustive version of drbrain#84, which only updated the docs in one place. Version 3.0 introduced kwargs to the initializer in this commit: 5d4b76c Aside from updating the written docs, the docs need to be regenerated to update the method signature -- right now, the docs for `Net::HTTP::Persistent::new` have an out-of-date signature of `new(name = nil, proxy = nil)`. Simply regenerating the docs even without these changes updates the signature to the correct `new(name: nil, proxy: nil, pool_size: DEFAULT_POOL_SIZE)`. Fixes drbrain#80 Probably fixes drbrain#81
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a more exhaustive version of #84, which only updated the docs in one place.
Version 3.0 introduced kwargs to the initializer in this commit: 5d4b76c
Aside from updating the written docs (i.e., this PR), the docs need to be regenerated/republished anyway to update the method signature — right now, the docs for
Net::HTTP::Persistent::newhave an out-of-date signature ofnew(name = nil, proxy = nil). Simply regenerating the docs even without these changes updates the signature to the correctnew(name: nil, proxy: nil, pool_size: DEFAULT_POOL_SIZE).net-http-persistent3.0 andfaradayincompatibility #80