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: add note about tls connection meta data methods #3746

Closed
wants to merge 1 commit into from

Conversation

Projects
None yet
5 participants
@DaftMonk
Copy link
Contributor

commented Nov 10, 2015

Document current behavior of TLSSocket, as discussed in #3545

@romankl romankl added tls doc labels Nov 10, 2015

@mscdex

This comment has been minimized.

Copy link
Contributor

commented Nov 10, 2015

When I first read this, I didn't know what methods were being referred to. You might include an example method (e.g. getPeerCertificate()) or two.

@DaftMonk DaftMonk force-pushed the DaftMonk:docs-tls-socket branch Nov 10, 2015

@DaftMonk

This comment has been minimized.

Copy link
Contributor Author

commented Nov 10, 2015

@mscdex Added an example.

@bnoordhuis

View changes

doc/api/tls.markdown Outdated
@@ -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.

This comment has been minimized.

Copy link
@bnoordhuis

bnoordhuis Nov 10, 2015

Member

Please wrap at 80 columns. Maybe you can turn getPeerCertificate() into a link?

This comment has been minimized.

Copy link
@DaftMonk

DaftMonk Nov 10, 2015

Author Contributor

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.

This comment has been minimized.

Copy link
@DaftMonk

DaftMonk Nov 10, 2015

Author Contributor

Never mind, I tried again and the link worked this time.

@DaftMonk DaftMonk force-pushed the DaftMonk:docs-tls-socket branch 5 times, most recently Nov 10, 2015

@DaftMonk DaftMonk force-pushed the DaftMonk:docs-tls-socket branch to 66a66d0 Nov 10, 2015

@bnoordhuis

This comment has been minimized.

Copy link
Member

commented Nov 10, 2015

Thanks, landed in eff8c3e.

@bnoordhuis bnoordhuis closed this Nov 10, 2015

bnoordhuis added a commit that referenced this pull request Nov 10, 2015

doc: add note on tls connection meta data methods
PR-URL: #3746
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>

Fishrock123 added a commit that referenced this pull request Nov 11, 2015

doc: add note on tls connection meta data methods
PR-URL: #3746
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>

@Fishrock123 Fishrock123 referenced this pull request Nov 11, 2015

Merged

Propose v5.1.0 #3736

MylesBorins added a commit that referenced this pull request Nov 17, 2015

doc: add note on tls connection meta data methods
PR-URL: #3746
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
@MylesBorins

This comment has been minimized.

Copy link
Member

commented Nov 17, 2015

landed in v4.x-staging in 8b6120d

@rvagg rvagg referenced this pull request Nov 17, 2015

Closed

v4.2.2+1 commit candidates #57

rvagg added a commit that referenced this pull request Dec 4, 2015

doc: add note on tls connection meta data methods
PR-URL: #3746
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>

@jasnell jasnell referenced this pull request Dec 17, 2015

Closed

Release 4.2.4 Planning #4321

jasnell added a commit that referenced this pull request Dec 17, 2015

doc: add note on tls connection meta data methods
PR-URL: #3746
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>

jasnell added a commit that referenced this pull request Dec 23, 2015

doc: add note on tls connection meta data methods
PR-URL: #3746
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.