From a718b26f288b46d4e18722c12f49b7e30a2eab32 Mon Sep 17 00:00:00 2001 From: Richard Lau Date: Tue, 27 Jul 2021 12:55:17 +0100 Subject: [PATCH] doc: fence command examples in release guide MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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: https://github.com/nodejs/node/pull/39544 Reviewed-By: Michaël Zasso Reviewed-By: Beth Griggs Reviewed-By: Danielle Adams Reviewed-By: James M Snell --- doc/guides/releases.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/doc/guides/releases.md b/doc/guides/releases.md index 79ca84674209c5..13dfefa9631e08 100644 --- a/doc/guides/releases.md +++ b/doc/guides/releases.md @@ -345,10 +345,14 @@ accordingly by removing the bold styling from the previous release. If this release includes new APIs then it is necessary to document that they were first added in this version. The relevant commits should already include `REPLACEME` tags as per the example in the -[docs README](../../tools/doc/README.md). Check for these tags with `grep -REPLACEME doc/api/*.md`, and substitute this node version with `sed -i -"s/REPLACEME/$VERSION/g" doc/api/*.md` or `perl -pi -e "s/REPLACEME/$VERSION/g" -doc/api/*.md`. +[docs README](../../tools/doc/README.md). Check for these tags with +```console +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 +``` `$VERSION` should be prefixed with a `v`.