-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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
doc: Grammar/typo fix for https.Agent section #4075
Conversation
@@ -195,7 +195,7 @@ Example: | |||
... | |||
} | |||
|
|||
Or does not use an `Agent`. | |||
Or don't use an `Agent`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you make this:
Alternatively, without an
Agent
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried to keep it to the grammar fix only. When changing the wording, I'd rather use something along these lines:
Alternatively, opt out of connection pooling.
That's how agent: false
is documented above and describes the intent/effect instead of an implementation detail.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about this, to make it more clear what is different:
Alternatively, opt out of connection pooling by not using an
Agent
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Updated.
0f0b4ca
to
0d49516
Compare
PR-URL: #4075 Reviewed-By: Colin Ihrig <[email protected]>
Thanks! LGTM and landed in 8eb153d. |
PR-URL: #4075 Reviewed-By: Colin Ihrig <[email protected]>
PR-URL: #4075 Reviewed-By: Colin Ihrig <[email protected]>
PR-URL: #4075 Reviewed-By: Colin Ihrig <[email protected]>
PR-URL: #4075 Reviewed-By: Colin Ihrig <[email protected]>
PR-URL: nodejs#4075 Reviewed-By: Colin Ihrig <[email protected]>
Changed to use imperative to be consistent with "use a custom
Agent
" above.