doc: Improve checkServerIdentity docs#17203
Uh oh!
There was an error while loading. Please reload this page.
Conversation
nodejs-github-bot added doc Hannes-Magnusson-CK commented Nov 21, 2017
See also #11467 |
doc/api/tls.md Outdated
There was a problem hiding this comment.
Can you please change this line to this?:
to be used instead of
tls.checkServerIdentity()
Backticks are appropriate here. Curly braces are for types. Thanks!
There was a problem hiding this comment.
Ahh. That makes sense. Thanks for the comment!
Fixed :)
Hannes-Magnusson-CKforce-pushed the patch-2 branch from 4bf98c7 to ea0cd07Compare
doc/api/tls.md Outdated
There was a problem hiding this comment.
Tiny nit: can you use tls.checkServerIdentity()? It seems to be the dominant style.
There was a problem hiding this comment.
of course! :) Updated
Hannes-Magnusson-CKforce-pushed the patch-2 branch from ea0cd07 to 15a4b95CompareHannes-Magnusson-CK commented Nov 22, 2017
Probably a dumb question, I'm new around here =): What makes those export more public then say https://github.com/nodejs/node/blob/master/lib/tls.js#L168 ? If thats purely source code readability, should I document the checkServerIdentity function? |
bnoordhuis commented Nov 22, 2017
@Hannes-Magnusson-CK The comment is a bit misguided / misleading, it should just be removed. You could read it as "these are the public and documented APIs" but some of the exports elsewhere are mentioned in the docs too, if only in passing. |
Hannes-Magnusson-CK commented Nov 22, 2017
Ok. Thanks @bnoordhuis ! |
The funciton was added in eb2ca10
Added a commit documenting |
| 'Please use querystring.parse() instead.', | ||
| 'DEP0076'); | ||
| // Public API |
There was a problem hiding this comment.
Its a misleading comment. These aren't the only exported functions.
addaleax added the author ready 
addaleax commented Dec 1, 2017
PR-URL: #17203 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
The funciton was added in eb2ca10 PR-URL: #17203 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
addaleax removed the author ready 
PR-URL: #17203 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
The funciton was added in eb2ca10 PR-URL: #17203 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
PR-URL: #17203 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
The funciton was added in eb2ca10 PR-URL: #17203 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
PR-URL: #17203 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
The funciton was added in eb2ca10 PR-URL: #17203 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
PR-URL: #17203 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
gibfahn commented Dec 19, 2017
PR-URL: #17203 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
The funciton was added in eb2ca10 PR-URL: #17203 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
9 participants
Checklist
Affected core subsystem(s)
tls doc