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.

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

doc: fix example commands for REPLACEME updates #41269

Merged
merged 1 commit into from
Jan 5, 2022

Conversation

richardlau
Copy link
Member

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.

Refs: #39544

cc @nodejs/releasers

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Dec 21, 2021
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.
@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Member Author

@richardlau richardlau Dec 21, 2021

Choose a reason for hiding this comment

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

👍, but let's do that in a separate PR.

@richardlau richardlau added the commit-queue Add this label to land a pull request using GitHub Actions. label Jan 5, 2022
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jan 5, 2022
@nodejs-github-bot nodejs-github-bot merged commit 5955880 into nodejs:master Jan 5, 2022
@nodejs-github-bot
Copy link
Collaborator

Landed in 5955880

@richardlau richardlau deleted the releaseguide branch January 5, 2022 19:45
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 <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Beth Griggs <[email protected]>
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 <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Beth Griggs <[email protected]>
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 <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Beth Griggs <[email protected]>
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 <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Beth Griggs <[email protected]>
@danielleadams danielleadams mentioned this pull request Feb 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants