Skip to content

Commit 5d34ac6

Browse files
author
Preeti Chandrashekar
committed
minor changes
1 parent d1f5642 commit 5d34ac6

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

supplementary_style_guide/style_guidelines/formatting.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,20 +51,20 @@ default active yes yes
5151
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[].
5252

5353
[[explain-commands-variables-in-code-blocks]]
54-
== Explain commands and vairables in code blocks
54+
== Explain commands and variables in code blocks
5555

5656
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.
5757

5858
. Use a simple sentence to explain or describe a single line of command, variable, option, or parameter.
5959
+
60-
.Example AsciiDoc: A simple sentence explainging a single coomand
60+
.Example AsciiDoc: A simple sentence explaining a single coomand
6161
+
6262
[source,terminal]
6363
----
6464
$ hcp create cluster <platform> --help
6565
----
6666
+
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`.
6868
+
6969
. Use a bulleted list to describe the structure of a sample YAML file or explain multiple lines of code in a code block.
7070
** List the explanations in the order in which they appear in the code block.
@@ -349,7 +349,7 @@ connection.interface-name: enp7s0
349349
----
350350
====
351351

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.
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.
353353

354354

355355
[[user-replaced-values-xml]]
@@ -397,7 +397,7 @@ This example renders as follows in HTML:
397397
----
398398
====
399399

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.
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.
401401

402402

403403

0 commit comments

Comments
 (0)