doc: fix example commands for REPLACEME updates
#41269
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
richardlau
force-pushed
the
releaseguide
branch
from
4732cc3 to
372c426
Compare
Split the two example command lines for updating the `REPLACEME` tags into separate `console` fenced code blocks. This fixes some stray "`" characters and makes each example one-click copiable when viewing the guide in GitHub's web UI.
richardlau
force-pushed
the
releaseguide
branch
from
372c426 to
3080b88
Compare
cjihrig
approved these changes
Dec 21, 2021
aduh95
approved these changes
Dec 21, 2021
| @@ -326,7 +326,13 @@ grep REPLACEME doc/api/*.md | |||
| and substitute this node version with | |||
|
|
|||
| ```console | |||
| sed -i "s/REPLACEME/$VERSION/g" doc/api/*.md` or `perl -pi -e "s/REPLACEME/$VERSION/g" doc/api/*.md | |||
| sed -i "s/REPLACEME/$VERSION/g" doc/api/*.md | |||
There was a problem hiding this comment.
Maybe it should be noted that the -i flag for sed is a GNU-specific one, so won't work everywhere (for example it doesn't work on macOS). Maybe that's outside the scope of this PR though.
There was a problem hiding this comment.
👍, but let's do that in a separate PR.
lpinca
approved these changes
Dec 22, 2021
BethGriggs
approved these changes
Jan 5, 2022
richardlau
added
the
commit-queue
nodejs-github-bot
removed
the
commit-queue
|
Landed in 5955880 |
targos
pushed a commit
that referenced
this pull request
Jan 14, 2022
Split the two example command lines for updating the `REPLACEME` tags into separate `console` fenced code blocks. This fixes some stray "`" characters and makes each example one-click copiable when viewing the guide in GitHub's web UI. PR-URL: #41269 Refs: #39544 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Beth Griggs <bgriggs@redhat.com>
danielleadams
pushed a commit
that referenced
this pull request
Jan 31, 2022
Split the two example command lines for updating the `REPLACEME` tags into separate `console` fenced code blocks. This fixes some stray "`" characters and makes each example one-click copiable when viewing the guide in GitHub's web UI. PR-URL: #41269 Refs: #39544 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Linkgoron
pushed a commit
to Linkgoron/node
that referenced
this pull request
Jan 31, 2022
Split the two example command lines for updating the `REPLACEME` tags into separate `console` fenced code blocks. This fixes some stray "`" characters and makes each example one-click copiable when viewing the guide in GitHub's web UI. PR-URL: nodejs#41269 Refs: nodejs#39544 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Beth Griggs <bgriggs@redhat.com>
danielleadams
pushed a commit
that referenced
this pull request
Feb 1, 2022
Split the two example command lines for updating the `REPLACEME` tags into separate `console` fenced code blocks. This fixes some stray "`" characters and makes each example one-click copiable when viewing the guide in GitHub's web UI. PR-URL: #41269 Refs: #39544 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Split the two example command lines for updating the
REPLACEMEtagsinto separate
consolefenced code blocks. This fixes some stray"`" characters and makes each example one-click copiable when viewing
the guide in GitHub's web UI.
Refs: #39544
cc @nodejs/releasers