doc: align doc/api/tls.markdown with style guide and fix minor grammatical issues #5706
Conversation
claudiorodriguez
added
tls
svozza
force-pushed
the
doc-tls-style-guide
branch
5 times, most recently
from
5e04f4b to
1b2aab8
Compare
| @@ -352,16 +356,16 @@ gets high. | |||
| This is a wrapped version of [`net.Socket`][] that does transparent encryption | |||
| of written data and all required TLS negotiation. | |||
|
|
|||
| This instance implements a duplex [Stream][] interfaces. It has all the | |||
| This instance implements the duplex [Stream][] interfaces. It has all the | |||
There was a problem hiding this comment.
Nit: wouldn't it be more correct to say it implements the duplex stream interface (singular)?
|
Very nice contribution - I left some comments - when those are addressed LGTM. |
|
Cool. I've addressed all the comments bar the two I need clarification on. I'll push the changes together when they're all done. |
svozza
force-pushed
the
doc-tls-style-guide
branch
2 times, most recently
from
d6c2422 to
e87183c
Compare
|
So I think I've addressed all the comments. |
|
Great, LGTM. Allow me to clarify the process - pull requests are open for 48 hours during week days in order to give collaborators opportunity to respond to them and suggest changes. In a day and a half assuming no one has objections (and hopefully more people read this) this will be landed in master. Pinging @nodejs/documentation in order to draw more attention to this issue since it's a big copy change. |
|
Good stuff. :) |
svozza
force-pushed
the
doc-tls-style-guide
branch
3 times, most recently
from
3a9d37a to
cb8297f
Compare
Brings tls.markdown into alignment with the node.js styleguide, specifically regarding the use of personal pronouns. Also, fixes various typos, punctuation errors, missing definite/indefinite articles and other minor grammatical issues.
svozza
force-pushed
the
doc-tls-style-guide
branch
from
cb8297f to
f246ec3
Compare
|
Actually, something I noticed is that none of the anchor links in the file work when I view the markdown files in the browser. Take, for example, this one which is supposed to point to |
|
LGTM |
Brings tls.markdown into alignment with the node.js styleguide, specifically regarding the use of personal pronouns. Also, fixes various typos, punctuation errors, missing definite/indefinite articles and other minor grammatical issues. PR-URL: #5706 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
|
Landed in 4f6ad5c 🎈🎈🎈 Thanks again. |
|
👍 |
Brings tls.markdown into alignment with the node.js styleguide, specifically regarding the use of personal pronouns. Also, fixes various typos, punctuation errors, missing definite/indefinite articles and other minor grammatical issues. PR-URL: #5706 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Conflicts: doc/api/tls.markdown
|
4f6ad5c is not landing cleanly onto v4.x-staging. Would someone be willing to backport? |
|
I can try, what exactly do I have to do? Just checkout the |
|
@svozza check out |
|
Good stuff. I'll give that a go. |
Brings tls.markdown into alignment with the node.js styleguide, specifically regarding the use of personal pronouns. Also, fixes various typos, punctuation errors, missing definite/indefinite articles and other minor grammatical issues. PR-URL: nodejs#5706 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Affected core subsystem(s)
Doc, TLS
Description of change
As discussed in #5677 (and tangentially, nodejs/docs#87) I've broken out the extra changes originally made in that PR into a separate one. Brings
tls.markdowninto alignment with the Node.js styleguide, specifically regarding the use of personal pronouns. Also, fixes various typos, punctuation errors, line wrapping violations, missing definite/indefinite articles and other minor grammatical issues.