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.

Sign up for GitHub

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

Jump to bottom

doc: fix various nits #19743

Closed
wants to merge 7 commits into from
Closed

doc: fix various nits #19743

wants to merge 7 commits into from

Conversation

vsemozhetbyt
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt commented Apr 2, 2018 •
edited
Loading

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

Commit 1: replace 2 hyphens (--) by spaced m-dash (—) as per STYLE_GUIDE.md.
Commit 2: space infix operators.
Commit 3: unify quotes in inline code spans (use only single quotes).
Commit 4: unify * Returns: (eliminate deviations).
Commit 5: dedupe spaces.

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Apr 2, 2018
@vsemozhetbyt
Copy link
Contributor Author

vsemozhetbyt commented Apr 2, 2018 •
edited
Loading

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite/385/

jasnell
jasnell approved these changes Apr 2, 2018
View reviewed changes
Copy link
Member

@jasnell jasnell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but proactively backporting this to LTS lines would be helpful.

@vsemozhetbyt
Copy link
Contributor Author

vsemozhetbyt commented Apr 2, 2018 •
edited
Loading

@jasnell I will do, but we have no codified algorithm for this, so I have some questions:

  1. Should I preserve 5 commits or should I squash them? (Currently, preserved)
  2. We have not a final metadata before landing, so should I just leave the initial one for now? (Currently, left initial)

@vsemozhetbyt vsemozhetbyt mentioned this pull request Apr 2, 2018
Closed
3 tasks
@vsemozhetbyt
Copy link
Contributor Author

Proactive backport to v8: #19753

@jasnell
Copy link
Member

jasnell commented Apr 2, 2018

For both questions, I don't really have any strong preferences. Others in @nodejs/backporting may have opinions tho.

@vsemozhetbyt vsemozhetbyt mentioned this pull request Apr 2, 2018
Closed
3 tasks
@vsemozhetbyt
Copy link
Contributor Author

Proactive backport to v6: #19761

@vsemozhetbyt
Copy link
Contributor Author

vsemozhetbyt commented Apr 2, 2018 •
edited
Loading

While backporting, I've found some new nits, so 2 small fixup commits are added.

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite/398/

@vsemozhetbyt vsemozhetbyt added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 2, 2018
@gibfahn
Copy link
Member

gibfahn commented Apr 3, 2018

Should I preserve 5 commits or should I squash them? (Currently, preserved)

Preserving is good.

We have not a final metadata before landing, so should I just leave the initial one for now? (Currently, left initial)

Leaving as the initial one for now is fine, if you could update the metadata once this PR lands on master that would be ideal.

@vsemozhetbyt
Copy link
Contributor Author

@gibfahn Thank you. Should I copy the metadata in each commit or in the first one only?

@gibfahn
Copy link
Member

gibfahn commented Apr 3, 2018

Should I copy the metadata in each commit or in the first one only?

Basically what we've been doing is having the backport commit metadata exactly match what goes onto master (with the exception of the Backport-PR-URL: which is added by the person who lands it).

If that becomes painful then we can revisit the decision.

@vsemozhetbyt
Copy link
Contributor Author

I mean, if I fixup these commits before landing, will it suffice to copy metadata in the first commit and note in the backport PR that all commits are bound to fixup?

@gibfahn
Copy link
Member

gibfahn commented Apr 3, 2018

I mean, if I fixup these commits before landing, will it suffice to copy metadata in the first commit and note in the backport PR that all commits are bound to fixup?

Technically no, but in practice we have to edit the commit metadata anyway to land the commits, so I'm fine with just adding the metadata to the first one.

@vsemozhetbyt
Copy link
Contributor Author

vsemozhetbyt commented Apr 4, 2018 •
edited
Loading

Rebased to resolve conflicts.
CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite/416/

@vsemozhetbyt
Copy link
Contributor Author

vsemozhetbyt commented Apr 4, 2018 •
edited
Loading

I cannot understand what is wrong with the linter job.
See #19788

@vsemozhetbyt
Copy link
Contributor Author

Green CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite/417/

vsemozhetbyt added a commit that referenced this pull request Apr 4, 2018
@vsemozhetbyt
doc: fix various nits
de0053c 
* Replace 2 hyphens (--) by spaced m-dashes (—) as per STYLE_GUIDE.md.
* Space infix operators.
* Unify quotes in inline code spans (use only single quotes).
* Unify `* Returns:` (eliminate deviations).
* Dedupe spaces.

PR-URL: #19743
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@vsemozhetbyt
Copy link
Contributor Author

Landed in de0053c

@vsemozhetbyt vsemozhetbyt deleted the doc-dashes branch April 4, 2018 10:47
@targos targos removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 4, 2018
targos pushed a commit that referenced this pull request Apr 4, 2018
@vsemozhetbyt @targos
doc: fix various nits
ae86adc 
* Replace 2 hyphens (--) by spaced m-dashes (—) as per STYLE_GUIDE.md.
* Space infix operators.
* Unify quotes in inline code spans (use only single quotes).
* Unify `* Returns:` (eliminate deviations).
* Dedupe spaces.

PR-URL: #19743
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@targos targos mentioned this pull request Apr 4, 2018
Merged
gibfahn pushed a commit that referenced this pull request Apr 11, 2018
@vsemozhetbyt @gibfahn
doc: fix various nits
c897815 
* Replace 2 hyphens (--) by spaced m-dashes (—) as per STYLE_GUIDE.md.
* Space infix operators.
* Unify quotes in inline code spans (use only single quotes).
* Unify `* Returns:` (eliminate deviations).
* Dedupe spaces.

PR-URL: #19743
Backport-PR-URL: #19753
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
MylesBorins pushed a commit that referenced this pull request Apr 13, 2018
@vsemozhetbyt @MylesBorins
doc: fix various nits
4d67369 
* Replace 2 hyphens (--) by spaced m-dashes (—) as per STYLE_GUIDE.md.
* Space infix operators.
* Unify quotes in inline code spans (use only single quotes).
* Unify `* Returns:` (eliminate deviations).
* Dedupe spaces.

Backport-PR-URL: #19761
PR-URL: #19743
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Apr 13, 2018
Merged
@MylesBorins MylesBorins mentioned this pull request May 2, 2018
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trivikr trivikr trivikr approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@vsemozhetbyt @jasnell @gibfahn @trivikr @targos @nodejs-github-bot