doc: remove reference to "credentials object"#26908
doc: remove reference to "credentials object"#26908sam-github wants to merge 2 commits intonodejs:masterfrom
Conversation
The reference is confusing because the object is actually of class SecureContext. There is no object with class "credentials". See: nodejs#20432 (comment)
d03b7a2 to
d4ce20b
Compare
doc/api/tls.md
Outdated
|
|
||
| The `tls.createSecureContext()` method creates a credentials object. | ||
| The `tls.createSecureContext()` method creates a `SecureContext` object. The | ||
| object has no public methods, but is accepted as an argument to several `tls` |
There was a problem hiding this comment.
Total micro-nit that you can ignore if you disagree, but I think the two sentences are clearer if you divide them up this way instead:
The `tls.createSecureContext()` method creates a `SecureContext` object with
no public methods. It is usable as an argument to several `tls` APIs such as
[`tls.createServer()`][] and [`server.addContext()`][].|
Landed in f11f180 |
The reference is confusing because the object is actually of class SecureContext. There is no object with class "credentials". See: #20432 (comment) PR-URL: #26908 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
The reference is confusing because the object is actually of class SecureContext. There is no object with class "credentials". See: #20432 (comment) PR-URL: #26908 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
The reference is confusing because the object is actually of class SecureContext. There is no object with class "credentials". See: #20432 (comment) PR-URL: #26908 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
The reference is confusing because the object is actually of class SecureContext. There is no object with class "credentials". See: #20432 (comment) PR-URL: #26908 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
|
@sam-github Why does Specifically, |
|
@cinderblock I can't speak to the history, but I can say if there is a specific feature you would like, please post a feature request. It will help to have some concrete use cases. There are lots of things we could just make public, but it takes short term effort to add tests and docs (though feature requests with an acompanying PR don't have to attract a volunteer), and long-term, it can make it harder to improve the node API if too much of our internals are exposed in the API. |
The reference is confusing because the object is actually of class SecureContext. There is no object with class "credentials". See: #20432 (comment) PR-URL: #26908 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
The reference is confusing because the object is actually of class
SecureContext. There is no object with class "credentials".
See: #20432 (comment)
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes