Skip to content

Fix doc example for Net::HTTP::Persistent.new #84

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

Merged
merged 1 commit into from
Apr 9, 2019
Merged

Fix doc example for Net::HTTP::Persistent.new #84

merged 1 commit into from
Apr 9, 2019

Conversation

jamesrwhite
Copy link
Contributor

  • Since 3.0 it now expects named parameters

Since upgrading from 2.x I was hitting a similar issue to #80

- Since 3.0 it now expects named parameters
tjschuck added a commit to tjschuck/net-http-persistent that referenced this pull request Apr 12, 2017
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
@tenderlove tenderlove merged commit d4ebd9a into drbrain:master Apr 9, 2019
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.

2 participants