-
Notifications
You must be signed in to change notification settings - Fork 28.9k
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: add note about tls connection meta data methods #3746
Conversation
When I first read this, I didn't know what methods were being referred to. You might include an example method (e.g. |
55677f2
to
4ffb9e3
Compare
@mscdex Added an example. |
@@ -764,6 +764,8 @@ of written data and all required TLS negotiation. | |||
This instance implements a duplex [Stream][] interfaces. It has all the | |||
common stream methods and events. | |||
|
|||
Methods that return TLS connection meta data (e.g. `getPeerCertificate()`) will only return data while the connection is open. |
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.
Please wrap at 80 columns. Maybe you can turn getPeerCertificate()
into a link?
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.
Updated to use correct column length.
I couldn't get intra-page links working for that section. I tried using the markdown
[getPeerCertificate](#tlssocketgetpeercertificate-detailed-)
and when I opened the preview in github and clicked on it, it didn't work. However typing in the url directly https://github.com/DaftMonk/node/blob/docs-tls-socket/doc/api/tls.markdown#tlssocketgetpeercertificate-detailed- did work.
So I'm not sure what the issue was, but I reverted it back to a code example.
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.
Never mind, I tried again and the link worked this time.
1f04c0b
to
0a414e8
Compare
0a414e8
to
66a66d0
Compare
Thanks, landed in eff8c3e. |
PR-URL: #3746 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
PR-URL: #3746 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
PR-URL: #3746 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
landed in v4.x-staging in 8b6120d |
PR-URL: #3746 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
PR-URL: #3746 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
PR-URL: #3746 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Document current behavior of TLSSocket, as discussed in #3545