doc: improve grammar in tls docs regarding #4246 #4315
Conversation
Add `secureContext` option to `tls.connect`. It is useful for caching client certificates, key, and CA certificates. PR-URL: #4246 Reviewed-By: James M Snell <[email protected]>
|
IMHO it would be better to have a more descriptive commit message like "doc: improve consistency and grammar in tls docs" instead of just linking to a PR. |
mscdex
added
tls
|
Ow yeah first pr so. I can update if you want. |
|
LGTM with the commit log change |
| @@ -542,9 +542,9 @@ Creates a new client connection to the given `port` and `host` (old API) or | |||
| `options.port` and `options.host`. (If `host` is omitted, it defaults to | |||
| `localhost`.) `options` should be an object which specifies: | |||
|
|
|||
| - `host`: Host the client should connect to | |||
There was a problem hiding this comment.
Let's keep this PR neat, please consider submitting this fixes in a separate pull request.
|
Updated the commit log or do you not want to reference the PR at all? |
|
Updated the commit per @indutny's comment |
AdriVanHoudt
changed the title
|
@AdriVanHoudt I know it is nitpicking, but could I ask you to move |
|
Otherwise LGTM, thank you! |
|
@indutny you want me to edit the title to remove the |
|
And also not a problem I understand you want a clean log of everything |
|
@AdriVanHoudt almost there! Could you please move |
|
@indutny uh the commit says that. Not sure what you mean. |
|
@AdriVanHoudt the commit has everything on the same line: AdriVanHoudt@54ff778 Please take a look at: 2a60e2a to see how it could be improved. Also https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#step-3-commit may be useful. |
|
@indutny ah I see now. Do I also need to put the PR url in there? |
|
@AdriVanHoudt that and reviewed-by will be put by us ;) But thanks for asking! |
Fix: nodejs#4246 PR-URL: nodejs#4315
|
@indutny ok fixed it |
Fix: #4246 PR-URL: #4315 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Fedor Indutny <[email protected]>
|
Landed in 2fd3d8a |
|
👍 |
|
It looks like the commit this modifies is semver minor and not in LTS. Removing lts-watch, please readd if I am mistaken @jasnell |
|
Hey @AdriVanHoudt, I think this is your first commit to core, congrats! Even though it's only a trivial change we appreciate the attention to detail and hope you stick around and continue to contribute! |
|
@rvagg thanks! Will definitely do another pr to fix those |
Fix: nodejs#4246 PR-URL: nodejs#4315 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Fedor Indutny <[email protected]>
Fix: nodejs#4246 PR-URL: nodejs#4315 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Fedor Indutny <[email protected]>
see c5b4f6b#commitcomment-15026937