-
Notifications
You must be signed in to change notification settings - Fork 29.8k
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
Conversation
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.
372c426
to
3080b88
Compare
@@ -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.
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.
There was a problem hiding this comment.
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.
Landed in 5955880 |
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]>
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]>
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]>
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]>
Split the two example command lines for updating the
REPLACEME
tagsinto 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