Skip to content

Commit 804a884

Browse files
authored
Merge pull request #534 from Preeticp/codeblock_updates
single_cmd_per_codeblock
2 parents d49384e + 91100e1 commit 804a884

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

supplementary_style_guide/style_guidelines/formatting.adoc

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[[commands-in-code-blocks]]
55
== Commands in code blocks
66

7-
Use a single command per code block for each procedure step. This approach helps with readability and makes it possible for the copy button in code blocks to work correctly.
7+
Use a single command per code block for each procedure step. Separate a command and its related example output into individual code blocks. This approach helps with readability and makes it possible for the copy button in code blocks to work correctly.
88

99
By default, use bold formatting for commands in code blocks to visually distinguish the commands from their lead-in sentences and from the command prompts and example outputs. For consistency, use bold formatting for commands even when no command output is shown in the code block.
1010

@@ -13,13 +13,17 @@ By default, use bold formatting for commands in code blocks to visually distingu
1313
To apply formatting in a code block, you must use the `quotes` link:https://docs.asciidoctor.org/asciidoc/latest/subs/apply-subs-to-blocks/[AsciiDoc substitution].
1414
====
1515

16-
.Example AsciiDoc: A command and its output in a code block
16+
.Example AsciiDoc: A command and its output in separate code blocks
1717

1818
Verify that the `libvirt` default network is active and configured to start automatically:
1919

2020
[subs="+quotes"]
2121
----
2222
# *virsh net-list --all*
23+
----
24+
25+
[subs="+quotes"]
26+
----
2327
Name State Autostart Persistent
2428
--------------------------------------------
2529
default active yes yes
@@ -34,6 +38,10 @@ Verify that the `libvirt` default network is active and configured to start auto
3438
[subs="+quotes"]
3539
----
3640
# *virsh net-list --all*
41+
----
42+
43+
[subs="+quotes"]
44+
----
3745
Name State Autostart Persistent
3846
--------------------------------------------
3947
default active yes yes

0 commit comments

Comments
 (0)