You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: supplementary_style_guide/style_guidelines/formatting.adoc
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,20 +51,20 @@ default active yes yes
51
51
For commands and command outputs in code blocks, observe the correct markup for user-replaced values, as described in xref:user-replaced-values[] and xref:user-replaced-values-xml[].
52
52
53
53
[[explain-commands-variables-in-code-blocks]]
54
-
== Explain commands and vairables in code blocks
54
+
== Explain commands and variables in code blocks
55
55
56
56
To explain commands, lines of code, or variables (user-replaced values) used in a code block, follow the code block with the relevant explanation or description of the elements.
57
57
58
58
. Use a simple sentence to explain or describe a single line of command, variable, option, or parameter.
59
59
+
60
-
.Example AsciiDoc: A simple sentence explainging a single coomand
60
+
.Example AsciiDoc: A simple sentence explaining a single coomand
61
61
+
62
62
[source,terminal]
63
63
----
64
64
$ hcp create cluster <platform> --help
65
65
----
66
66
+
67
-
You can use the `hcp create cluster` command to create and manage hosted clusters. The supported platforms are `aws`, `agent`, and `kubevirt`.
67
+
Use the `hcp create cluster` command to create and manage hosted clusters. The supported platforms are `aws`, `agent`, and `kubevirt`.
68
68
+
69
69
. Use a bulleted list to describe the structure of a sample YAML file or explain multiple lines of code in a code block.
70
70
** List the explanations in the order in which they appear in the code block.
To explain userreplaced values used in a code block, you must use a definition list following the code block. See xref:explain-commands-variables-in-code-blocks[] for details.
352
+
To explain user-replaced values used in a code block, you must use a definition list following the code block. See xref:explain-commands-variables-in-code-blocks[] for details.
353
353
354
354
355
355
[[user-replaced-values-xml]]
@@ -397,7 +397,7 @@ This example renders as follows in HTML:
397
397
----
398
398
====
399
399
400
-
To explain userreplaced values used in a code block, you must use a definition list following the code block. See xref:explain-commands-variables-in-code-blocks[] for details.
400
+
To explain user-replaced values used in a code block, you must use a definition list following the code block. See xref:explain-commands-variables-in-code-blocks[] for details.
0 commit comments