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: normalize shell session code block info strings #33486

Closed
wants to merge 1 commit into from
Closed

doc: normalize shell session code block info strings #33486

wants to merge 1 commit into from

Conversation

DerekNonGeneric
Copy link
Contributor

@DerekNonGeneric DerekNonGeneric commented May 20, 2020 •
edited
Loading

Prior to this commit, shell fenced code blocks in Markdown files had
inconsistent info strings. This has been corrected to standarize on
the one with the highest frequency in the doc/api/ dir.

Stats:

'console' => 54,
'shell' => 2,

Checklist

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. npm Issues and PRs related to the npm client dependency or the npm registry. labels May 20, 2020
lpinca
lpinca approved these changes May 20, 2020
View reviewed changes
deps/npm/docs/content/cli-commands/npm-build.md Outdated Show resolved Hide resolved
@DerekNonGeneric
Copy link
Contributor Author

DerekNonGeneric commented May 23, 2020 •
edited
Loading

Apologies; I had been thinking that console meant anything showing up in the terminal, but seem to have been mistaken. This will probably need a second round of review. The documentation style guide would benefit from a description of a Shell Session (leading $ et al.) too.

Meaning Info string/class
Shell Session console, shell

shell-session

@DerekNonGeneric DerekNonGeneric changed the title docs: normalize shell code block info strings doc: normalize shell session code block info strings May 23, 2020
@DerekNonGeneric DerekNonGeneric marked this pull request as draft May 23, 2020 01:49
@DerekNonGeneric DerekNonGeneric changed the title doc: normalize shell session code block info strings docs: normalize shell session code block info strings May 23, 2020
@DerekNonGeneric
Copy link
Contributor Author

This PR now falls in line so that #33028 would be able to be merged without any additional changes.

@DerekNonGeneric DerekNonGeneric marked this pull request as ready for review May 23, 2020 23:05
@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 23, 2020
doc: normalize shell code block info strings
d3c68bd 
Prior to this commit, shell fenced code blocks in Markdown files had
inconsistent info strings. This has been corrected to standarize on
the one with the highest frequency in the doc/api/ dir.

Stats:
> 'console' => 54,
> 'shell' => 2,
@DerekNonGeneric DerekNonGeneric changed the title docs: normalize shell session code block info strings doc: normalize shell session code block info strings May 24, 2020
BridgeAR pushed a commit to BridgeAR/node that referenced this pull request May 25, 2020
@DerekNonGeneric @BridgeAR
doc: normalize shell code block info strings
5632ff6 
Prior to this commit, shell fenced code blocks in Markdown files had
inconsistent info strings. This has been corrected to standarize on
the one with the highest frequency in the doc/api/ dir.

Stats:
> 'console' => 54,
> 'shell' => 2,

PR-URL: nodejs#33486
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@BridgeAR
Copy link
Member

Landed in 5632ff6

@BridgeAR BridgeAR closed this May 25, 2020
codebytere pushed a commit that referenced this pull request Jun 18, 2020
@codebytere
doc: normalize shell code block info strings
4cc391b 
Prior to this commit, shell fenced code blocks in Markdown files had
inconsistent info strings. This has been corrected to standarize on
the one with the highest frequency in the doc/api/ dir.

Stats:
> 'console' => 54,
> 'shell' => 2,

PR-URL: #33486
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Trott pushed a commit that referenced this pull request Jun 25, 2020
@Trott
doc: add allowed info strings to style guide
e405e82 
This commit adds the list of agreed-upon info strings to the
documentation style guide to aid with future development and
maintenance.

Refs: #33510
Refs: #33507
Refs: #33483
Refs: #33531
Refs: #33542
Refs: #33028
Refs: #33548
Refs: #33486

PR-URL: #34024
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
codebytere pushed a commit that referenced this pull request Jun 27, 2020
@codebytere
doc: add allowed info strings to style guide
4323346 
This commit adds the list of agreed-upon info strings to the
documentation style guide to aid with future development and
maintenance.

Refs: #33510
Refs: #33507
Refs: #33483
Refs: #33531
Refs: #33542
Refs: #33028
Refs: #33548
Refs: #33486

PR-URL: #34024
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@codebytere codebytere mentioned this pull request Jun 28, 2020
Merged
codebytere pushed a commit that referenced this pull request Jun 30, 2020
@codebytere
doc: normalize shell code block info strings
754c7ef 
Prior to this commit, shell fenced code blocks in Markdown files had
inconsistent info strings. This has been corrected to standarize on
the one with the highest frequency in the doc/api/ dir.

Stats:
> 'console' => 54,
> 'shell' => 2,

PR-URL: #33486
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
codebytere pushed a commit that referenced this pull request Jun 30, 2020
@codebytere
doc: add allowed info strings to style guide
b641a13 
This commit adds the list of agreed-upon info strings to the
documentation style guide to aid with future development and
maintenance.

Refs: #33510
Refs: #33507
Refs: #33483
Refs: #33531
Refs: #33542
Refs: #33028
Refs: #33548
Refs: #33486

PR-URL: #34024
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
codebytere pushed a commit that referenced this pull request Jul 8, 2020
@codebytere
doc: normalize shell code block info strings
7ea6b07 
Prior to this commit, shell fenced code blocks in Markdown files had
inconsistent info strings. This has been corrected to standarize on
the one with the highest frequency in the doc/api/ dir.

Stats:
> 'console' => 54,
> 'shell' => 2,

PR-URL: #33486
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
codebytere pushed a commit that referenced this pull request Jul 10, 2020
@codebytere
doc: add allowed info strings to style guide
5a9b809 
This commit adds the list of agreed-upon info strings to the
documentation style guide to aid with future development and
maintenance.

Refs: #33510
Refs: #33507
Refs: #33483
Refs: #33531
Refs: #33542
Refs: #33028
Refs: #33548
Refs: #33486

PR-URL: #34024
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
codebytere pushed a commit that referenced this pull request Jul 12, 2020
@codebytere
doc: add allowed info strings to style guide
04ceeaf 
This commit adds the list of agreed-upon info strings to the
documentation style guide to aid with future development and
maintenance.

Refs: #33510
Refs: #33507
Refs: #33483
Refs: #33531
Refs: #33542
Refs: #33028
Refs: #33548
Refs: #33486

PR-URL: #34024
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@codebytere codebytere mentioned this pull request Jul 13, 2020
Merged
codebytere pushed a commit that referenced this pull request Jul 14, 2020
@codebytere
doc: add allowed info strings to style guide
d9bfac6 
This commit adds the list of agreed-upon info strings to the
documentation style guide to aid with future development and
maintenance.

Refs: #33510
Refs: #33507
Refs: #33483
Refs: #33531
Refs: #33542
Refs: #33028
Refs: #33548
Refs: #33486

PR-URL: #34024
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BridgeAR BridgeAR BridgeAR approved these changes

@lpinca lpinca lpinca approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. npm Issues and PRs related to the npm client dependency or the npm registry.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@DerekNonGeneric @BridgeAR @jasnell @lpinca @nodejs-github-bot