Fix fixed-width rendering in metrics doc

The backticks in the template heredoc were evaluated by the shell and lost. This change escapes them to prevent evaluation. FAB-17422 Change-Id: Ia38d1fe1fdd569d562c6272f1cd45425b253a93b Signed-off-by: Matthew Sykes <[email protected]>
CanisMinor-1037 · Feb 11, 2020 · 7d4e8f1 · 7d4e8f1
1 parent ff5e2da
commit 7d4e8f1
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/docs/source/metrics_reference.rst b/docs/source/metrics_reference.rst
@@ -204,10 +204,10 @@ StatsD
 ~~~~~~
 
 The following orderer metrics are emitted for consumption by StatsD. The
-%{variable_name} nomenclature represents segments that vary based on
+``%{variable_name}`` nomenclature represents segments that vary based on
 context.
 
-For example, %{channel} will be replaced with the name of the channel
+For example, ``%{channel}`` will be replaced with the name of the channel
 associated with the metric.
 
 +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
@@ -569,10 +569,10 @@ StatsD
 ~~~~~~
 
 The following peer metrics are emitted for consumption by StatsD. The
-%{variable_name} nomenclature represents segments that vary based on
+``%{variable_name}`` nomenclature represents segments that vary based on
 context.
 
-For example, %{channel} will be replaced with the name of the channel
+For example, ``%{channel}`` will be replaced with the name of the channel
 associated with the metric.
 
 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+

diff --git a/scripts/metrics_doc.sh b/scripts/metrics_doc.sh
@@ -42,10 +42,10 @@ StatsD
 ~~~~~~
 
 The following orderer metrics are emitted for consumption by StatsD. The
-``%{variable_name}`` nomenclature represents segments that vary based on
+\`\`%{variable_name}\`\` nomenclature represents segments that vary based on
 context.
 
-For example, ``%{channel}`` will be replaced with the name of the channel
+For example, \`\`%{channel}\`\` will be replaced with the name of the channel
 associated with the metric.
 
 ${orderer_statsd}
@@ -64,10 +64,10 @@ StatsD
 ~~~~~~
 
 The following peer metrics are emitted for consumption by StatsD. The
-``%{variable_name}`` nomenclature represents segments that vary based on
+\`\`%{variable_name}\`\` nomenclature represents segments that vary based on
 context.
 
-For example, ``%{channel}`` will be replaced with the name of the channel
+For example, \`\`%{channel}\`\` will be replaced with the name of the channel
 associated with the metric.
 
 ${peer_statsd}