Skip to content

Commit a718b26

Browse files
richardlautargos
authored andcommitted
doc: fence command examples in release guide
Put the command examples for finding and replacing the `REPLACEME` tags into code fences so that they are more easily copiable when viewing the guide in the GitHub web UI. PR-URL: #39544 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Beth Griggs <[email protected]> Reviewed-By: Danielle Adams <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 42669bb commit a718b26

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

doc/guides/releases.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -345,10 +345,14 @@ accordingly by removing the bold styling from the previous release.
345345
If this release includes new APIs then it is necessary to document that they
346346
were first added in this version. The relevant commits should already include
347347
`REPLACEME` tags as per the example in the
348-
[docs README](../../tools/doc/README.md). Check for these tags with `grep
349-
REPLACEME doc/api/*.md`, and substitute this node version with `sed -i
350-
"s/REPLACEME/$VERSION/g" doc/api/*.md` or `perl -pi -e "s/REPLACEME/$VERSION/g"
351-
doc/api/*.md`.
348+
[docs README](../../tools/doc/README.md). Check for these tags with
349+
```console
350+
grep REPLACEME doc/api/*.md
351+
```
352+
and substitute this node version with
353+
```console
354+
sed -i "s/REPLACEME/$VERSION/g" doc/api/*.md` or `perl -pi -e "s/REPLACEME/$VERSION/g" doc/api/*.md
355+
```
352356

353357
`$VERSION` should be prefixed with a `v`.
354358

0 commit comments

Comments
 (0)