Backport of #5706 to v4.x by svozza · Pull Request #5983 · nodejs/node

svozza · 2016-03-31T22:06:13Z

This is a backport of #5706 (doc: align doc/api/tls.markdown with style guide) to the v4.x-staging branch as requested @thealphanerd.

jasnell · 2016-04-01T16:43:33Z

@svozza ... can you rebase your branch to the current v4.x-staging to clear out the extraneous commits here?

svozza · 2016-04-01T19:51:30Z

Oh this is weird, I ddn't see all those extra commits. I'm not actually sure how this happened. I didn't have the v4.x-staging branch before I did this change. All I did was this:

git checkout -b v4.x-staging upstream/v4.x-staging
git cherry-pick 4f6ad5c
git push -u origin v4.x-staging

My branch said it was only 1 commit ahead when I made the PR and when I do git rebase upstream/v4.x-staging it tells me I'm up to date.

svozza · 2016-04-01T22:12:22Z

OK. I think I've fixed it.

MylesBorins · 2016-04-01T22:30:11Z

This should not have made it into the backport
ALPN support is only on v5.x +
#2564
Please move this section

Ah yes, I wasn't sure about that ALPN stuff. I'll remove the references.

MylesBorins · 2016-04-01T22:32:53Z

@svozza when you cherry picked did you have conflicts? It appears to me like you merged all of the latest changes as opposed to manually handling the conflicts, as such we have a bunch of documentation in here about ALPN which is not a feature in v4.x

I would suggest you might find it easier in the sections with conflicts to opt for the version present in v4, not in your commit and simply reaudit those sections to make sure they are correct

svozza · 2016-04-01T22:54:09Z

Done.

MylesBorins · 2016-04-04T20:50:50Z

where did this come from?

MylesBorins · 2016-04-04T20:52:13Z

@svozza I'm still seeing quite a bit of information in here of v5 specific documentation. Would you be open to redoing this fix from scratch using the v4 doc? Sorry for being tight on this, but I really don't want to accidentally merge incorrect docs

svozza · 2016-04-04T20:54:43Z

Yeah, no problem. I think I made a mess of the rebase.

MylesBorins · 2016-04-08T21:00:11Z

@svozza thanks for all the hard work!

MylesBorins · 2016-04-11T17:10:13Z

@svozza let me know if I can help with anything

svozza · 2016-04-11T17:13:56Z

Really sorry about the delay, will be able to get to it tonight though!

svozza · 2016-04-11T20:42:45Z

So I just blew away the branch and started over. No rebasing or any messing around and I think it worked out much better.

whitlockjc · 2016-04-11T20:52:14Z

I apologize, I was commenting on a backport after the original commit was already accepted. I've removed my nits and will instead address these in a future PR

svozza · 2016-04-11T20:57:22Z

Oh right, I was in the process of fixing them! :) I agree that 'This event is emitted...` reads better btw.

MylesBorins · 2016-04-11T21:04:59Z

@whitlockjc the review is appreciated. This backport ended up having to be a complete rewrite due to the differences (to a certain extent).

whitlockjc · 2016-04-11T21:53:59Z

Well, if I wasn't out of line, let me add them back. Thanks for stepping in @thealphanerd and @svozza for being so willing to help. <3.

whitlockjc · 2016-04-11T21:55:44Z

For consistency, we might use "This event is emitted" like we did for the 'secure' event.

whitlockjc · 2016-04-11T21:57:46Z

Same as above for 'clientError' event.

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>

svozza · 2016-04-11T22:02:06Z

Think I got them all!

whitlockjc · 2016-04-11T22:03:58Z

I'll take another peek. I also see a number of places where we're using a trailing . for option/argument descriptions that themselves are not full sentences. These have been there for some time and for consistency, using what was there makes sense. But if you wanted to clean those up, I wouldn't mind. (I might be in the wrong on that one so I'll state my opinion and let someone else decide.)

whitlockjc · 2016-04-11T22:12:09Z

@svozza Thanks for addressing the NOTE: and event inconsistencies. The inconsistencies with the trailing periods for argument/option documentation is rampant but this did not start with you.

If no one else has an opinion on the argument/option documentation inconsistencies, LGTM.

svozza · 2016-04-11T22:12:11Z

Yeah, I really wasn't sure what to do there so I left it originally. I was leaning towards putting fullstops everywhere but thought it might be best not to go down that rabbithole.

whitlockjc · 2016-04-11T22:12:44Z

Let's see what @thealphanerd has to say. Others welcome of course as well but he was last involved before myself. Great job regardless.

MylesBorins · 2016-04-14T06:53:30Z

If something is consistent in the docs and not specific to this change I think it should come in another update

whitlockjc · 2016-04-14T22:01:27Z

@thealphanerd That's what I was thinking. Seems you've assigned to yourself so I'll step out and let you merge when it's ready. Thanks for stepping in.

MylesBorins · 2016-04-14T22:04:41Z

cool.. can I get an official LGTM from you @whitlockjc

jasnell · 2016-04-27T05:36:22Z

ping @whitlockjc

MylesBorins · 2016-06-06T22:08:02Z

ping @whitlockjc

I'm going to close for now, please feel free to reopen

mscdex added the v4.x label Mar 31, 2016

MylesBorins force-pushed the v4.x-staging branch from df3a543 to 7384140Compare April 1, 2016 01:32

jasnell added the lts-watch-v4.x label Apr 1, 2016

svozza force-pushed the v4.x-staging branch from aaed1d1 to 259e27fCompare April 1, 2016 22:11

MylesBorins reviewed Apr 1, 2016
View reviewed changes

svozza force-pushed the v4.x-staging branch from 259e27f to 4c455eeCompare April 1, 2016 22:53

MylesBorins reviewed Apr 4, 2016
View reviewed changes

Comment threaddoc/api/tls.markdown Outdated
MylesBorinsApr 4, 2016
Copy link
Copy Markdown
Contributor
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
where did this come from?

Fishrock123 added the is-backport label Apr 5, 2016

svozza force-pushed the v4.x-staging branch from 4c455ee to db321fcCompare April 11, 2016 20:39

whitlockjc reviewed Apr 11, 2016
View reviewed changes

Comment threaddoc/api/tls.markdown Outdated
whitlockjcApr 11, 2016
Copy link
Copy Markdown
Contributor
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above for 'clientError' event.

svozza force-pushed the v4.x-staging branch from db321fc to 58716ccCompare April 11, 2016 22:00

MylesBorins self-assigned this Apr 14, 2016

MylesBorins force-pushed the v4.x-staging branch from 6291de2 to a8312f2Compare April 22, 2016 17:50

mscdex removed the is-backport label May 4, 2016

MylesBorins force-pushed the v4.x-staging branch from b511c5a to 8501783Compare May 6, 2016 01:29

MylesBorins force-pushed the v4.x-staging branch from c6db822 to 6330f48Compare May 24, 2016 18:47

MylesBorins closed this Jun 6, 2016

MylesBorins removed the lts-watch-v4.x label Jul 11, 2016

MylesBorins removed their assignment Dec 27, 2016

Uh oh!

Uh oh!

Conversation

svozza commented Mar 31, 2016

Uh oh!

jasnell commented Apr 1, 2016

Uh oh!

svozza commented Apr 1, 2016

Uh oh!

svozza commented Apr 1, 2016

Uh oh!

MylesBorinsApr 1, 2016

Choose a reason for hiding this comment

Uh oh!

svozzaApr 1, 2016

Choose a reason for hiding this comment

Uh oh!

MylesBorins commented Apr 1, 2016

Uh oh!

svozza commented Apr 1, 2016

Uh oh!

MylesBorinsApr 4, 2016

Choose a reason for hiding this comment

Uh oh!

MylesBorins commented Apr 4, 2016

Uh oh!

svozza commented Apr 4, 2016

Uh oh!

MylesBorins commented Apr 8, 2016

Uh oh!

MylesBorins commented Apr 11, 2016

Uh oh!

svozza commented Apr 11, 2016

Uh oh!

svozza commented Apr 11, 2016

Uh oh!

whitlockjc commented Apr 11, 2016

Uh oh!

svozza commented Apr 11, 2016

Uh oh!

MylesBorins commented Apr 11, 2016

Uh oh!

whitlockjc commented Apr 11, 2016

Uh oh!

whitlockjcApr 11, 2016

Choose a reason for hiding this comment

Uh oh!

whitlockjcApr 11, 2016

Choose a reason for hiding this comment

Uh oh!

svozza commented Apr 11, 2016

Uh oh!

whitlockjc commented Apr 11, 2016

Uh oh!

whitlockjc commented Apr 11, 2016

Uh oh!

svozza commented Apr 11, 2016

Uh oh!

whitlockjc commented Apr 11, 2016

Uh oh!

MylesBorins commented Apr 14, 2016

Uh oh!

whitlockjc commented Apr 14, 2016

Uh oh!

MylesBorins commented Apr 14, 2016

Uh oh!

jasnell commented Apr 27, 2016

Uh oh!

MylesBorins commented Jun 6, 2016• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

MylesBorins commented Jun 6, 2016•
edited
Loading