drbrain / net-http-persistent

Thread-safe persistent connections with Net::HTTP
http://seattlerb.rubyforge.org/net-http-persistent
339 stars 117 forks source link

Update initializer docs to use kwargs for `name` #85

Closed tjschuck closed 5 years ago

tjschuck commented 7 years ago

This is a more exhaustive version of https://github.com/drbrain/net-http-persistent/pull/84, which only updated the docs in one place.

Version 3.0 introduced kwargs to the initializer in this commit: 5d4b76c22dd38d29b6fbc1ed700a2a1c78c5abc4

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::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).