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

doc: Grammar/typo fix for https.Agent section #4075

Closed
wants to merge 1 commit into from

Conversation

jkrems
Copy link
Contributor

@jkrems jkrems commented Nov 30, 2015

Changed to use imperative to be consistent with "use a custom Agent" above.

@mscdex mscdex added https Issues or PRs related to the https subsystem. doc Issues and PRs related to the documentations. labels Nov 30, 2015
@@ -195,7 +195,7 @@ Example:
...
}

Or does not use an `Agent`.
Or don't use an `Agent`.
Copy link
Contributor

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.

Copy link
Contributor Author

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.

Copy link
Contributor

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks! Updated.

cjihrig pushed a commit that referenced this pull request Dec 2, 2015
PR-URL: #4075
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@cjihrig
Copy link
Contributor

cjihrig commented Dec 2, 2015

Thanks! LGTM and landed in 8eb153d.

@cjihrig cjihrig closed this Dec 2, 2015
@jkrems jkrems deleted the https-doc-typo branch December 2, 2015 17:03
rvagg pushed a commit that referenced this pull request Dec 5, 2015
PR-URL: #4075
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this pull request Dec 15, 2015
PR-URL: #4075
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@jasnell jasnell mentioned this pull request Dec 17, 2015
jasnell pushed a commit that referenced this pull request Dec 17, 2015
PR-URL: #4075
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
PR-URL: #4075
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
scovetta pushed a commit to scovetta/node that referenced this pull request Apr 2, 2016
PR-URL: nodejs#4075
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. https Issues or PRs related to the https subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants