Improvements to Text Markup examples (#915)

BurdetteLamar · web-flow · commit d00ddfe57c10 · 2022-08-11T11:43:39.000-05:00
diff --git a/doc/rdoc/markup_reference.rb b/doc/rdoc/markup_reference.rb
@@ -649,27 +649,27 @@
 #
 # Example input:
 #
-#   <i>Two words</i> in a paragraph.
+#   <i>Italicized words</i> in a paragraph.
 #
 #   >>>
-#     <i>Two words in a block quote</i>.
+#     <i>Italicized words in a block quote</i>.
 #
-#   - <i>Two words</i> in a bullet list item.
+#   - <i>Italicized words</i> in a list item.
 #
-#   ====== <i>Two words</i> in a Heading
+#   ====== <i>Italicized words</i> in a Heading
 #
 #   <i>Italicized passage containing *bold* and +monofont+.</i>
 #
 # Rendered HTML:
 # >>>
-#   <i>Two words</i> in a paragraph.
+#   <i>Italicized words</i> in a paragraph.
 #
 #   >>>
-#     <i>Two words in a block quote</i>.
+#     <i>Italicized words in a block quote</i>.
 #
-#   - <i>Two words</i> in a bullet list item.
+#   - <i>Italicized words</i> in a list item.
 #
-#   ====== <i>Two words</i> in a Heading
+#   ====== <i>Italicized words</i> in a Heading
 #
 #   <i>Italicized passage containing *bold* and +monofont+.</i>
 #
@@ -678,58 +678,54 @@
 #
 # Example input:
 #
-#   _Word_ in a paragraph.
+#   _Italic_ in a paragraph.
 #
 #   >>>
-#     _Word_ in a block quote.
+#     _Italic_ in a block quote.
 #
-#   - _Word_ in a bullet list item.
+#   - _Italic_ in a list item.
 #
-#   [_word_] _Word_ in a labeled list item.
-#
-#   ====== _Word_ in a Heading
+#   ====== _Italic_ in a Heading
 #
 # Rendered HTML:
 # >>>
-#   _Word_ in a paragraph.
+#   _Italic_ in a paragraph.
 #
 #   >>>
-#     _Word_ in a block quote.
-#
-#   - _Word_ in a bullet list item.
+#     _Italic_ in a block quote.
 #
-#   [_word_] _Word_ in a labeled list item.
+#   - _Italic_ in a list item.
 #
-#   ====== _Word_ in a Heading
+#   ====== _Italic_ in a Heading
 #
 # ===== Bold
 #
 # Text may be marked as bold via HTML tag <tt><b></tt>.
 #
 # Example input:
 #
-#   <b>Two words</b> in a paragraph.
+#   <b>Bold words</b> in a paragraph.
 #
 #   >>>
-#     <b>Two words</b> in a block quote.
+#     <b>Bold words</b> in a block quote.
 #
-#   - <b>Two words</b> in a bullet list item.
+#   - <b>Bold words</b> in a list item.
 #
-#   ====== <b>Two words</b> in a Heading
+#   ====== <b>Bold words</b> in a Heading
 #
 #   <b>Bold passage containing _italics_ and +monofont+.</b>
 #
 # Rendered HTML:
 #
 # >>>
-#   <b>Two words</b> in a paragraph.
+#   <b>Bold words</b> in a paragraph.
 #
 #   >>>
-#     <b>Two words</b> in a block quote.
+#     <b>Bold words</b> in a block quote.
 #
-#   - <b>Two words</b> in a bullet list item.
+#   - <b>Bold words</b> in a list item.
 #
-#   ====== <b>Two words</b> in a Heading
+#   ====== <b>Bold words</b> in a Heading
 #
 #   <b>Bold passage containing _italics_ and +monofont+.</b>
 #
@@ -738,30 +734,26 @@
 #
 # Example input:
 #
-#   *Word* in a paragraph.
+#   *Bold* in a paragraph.
 #
 #   >>>
-#     *Word* in a block quote.
+#     *Bold* in a block quote.
 #
-#   - *Word* in a bullet list item.
+#   - *Bold* in a list item.
 #
-#   [*word*] *Word* in a labeled list item.
-#
-#   ===== *Word* in a Heading
+#   ===== *Bold* in a Heading
 #
 # Rendered HTML:
 #
 # >>>
-#   *Word* in a paragraph.
+#   *Bold* in a paragraph.
 #
 #   >>>
-#     *Word* in a block quote.
-#
-#   - *Word* in a bullet list item.
+#     *Bold* in a block quote.
 #
-#   [*word*] *Word* in a labeled list item.
+#   - *Bold* in a list item.
 #
-#   ===== *Word* in a Heading
+#   ===== *Bold* in a Heading
 #
 # ===== Monofont
 #
@@ -771,28 +763,28 @@
 #
 # Example input:
 #
-#   <tt>Two words</tt> in a paragraph.
+#   <tt>Monofont words</tt> in a paragraph.
 #
 #   >>>
-#     <tt>Two words</tt> in a block quote.
+#     <tt>Monofont words</tt> in a block quote.
 #
-#   - <tt>Two words</tt> in a bullet list item.
+#   - <tt>Monofont words</tt> in a list item.
 #
-#   ====== <tt>Two words</tt> in heading
+#   ====== <tt>Monofont words</tt> in heading
 #
 #   <tt>Monofont passage containing _italics_ and *bold*.</tt>
 #
 # Rendered HTML:
 #
 # >>>
-#   <tt>Two words</tt> in a paragraph.
+#   <tt>Monofont words</tt> in a paragraph.
 #
 #   >>>
-#     <tt>Two words</tt> in a block quote.
+#     <tt>Monofont words</tt> in a block quote.
 #
-#   - <tt>Two words</tt> in a bullet list item.
+#   - <tt>Monofont words</tt> in a list item.
 #
-#   ====== <tt>Two words</tt> in heading
+#   ====== <tt>Monofont words</tt> in heading
 #
 #   <tt>Monofont passage containing _italics_ and *bold*.</tt>
 #
@@ -801,26 +793,26 @@
 #
 # Example input:
 #
-#   +Word+ in a paragraph.
+#   +Monofont+ in a paragraph.
 #
 #   >>>
-#     +Word+ in a block quote.
+#     +Monofont+ in a block quote.
 #
-#   - +Word+ in a bullet list item.
+#   - +Monofont+ in a list item.
 #
-#   ====== +Word+ in a Heading
+#   ====== +Monofont+ in a Heading
 #
 # Rendered HTML:
 #
 # >>>
-#   +Word+ in a paragraph.
+#   +Monofont+ in a paragraph.
 #
 #   >>>
-#     +Word+ in a block quote.
+#     +Monofont+ in a block quote.
 #
-#   - +Word+ in a bullet list item.
+#   - +Monofont+ in a list item.
 #
-#   ====== +Word+ in a Heading
+#   ====== +Monofont+ in a Heading
 #
 # ==== Escaping Text Markup
 #

Original file line number	Diff line number	Diff line change
`@@ -649,27 +649,27 @@`
`649`	`649`	`#`
`650`	`650`	`# Example input:`
`651`	`651`	`#`
`652`		`-# <i>Two words</i> in a paragraph.`
	`652`	`+# <i>Italicized words</i> in a paragraph.`
`653`	`653`	`#`
`654`	`654`	`# >>>`
`655`		`-# <i>Two words in a block quote</i>.`
	`655`	`+# <i>Italicized words in a block quote</i>.`
`656`	`656`	`#`
`657`		`-# - <i>Two words</i> in a bullet list item.`
	`657`	`+# - <i>Italicized words</i> in a list item.`
`658`	`658`	`#`
`659`		`-# ====== <i>Two words</i> in a Heading`
	`659`	`+# ====== <i>Italicized words</i> in a Heading`
`660`	`660`	`#`
`661`	`661`	`# <i>Italicized passage containing bold and +monofont+.</i>`
`662`	`662`	`#`
`663`	`663`	`# Rendered HTML:`
`664`	`664`	`# >>>`
`665`		`-# <i>Two words</i> in a paragraph.`
	`665`	`+# <i>Italicized words</i> in a paragraph.`
`666`	`666`	`#`
`667`	`667`	`# >>>`
`668`		`-# <i>Two words in a block quote</i>.`
	`668`	`+# <i>Italicized words in a block quote</i>.`
`669`	`669`	`#`
`670`		`-# - <i>Two words</i> in a bullet list item.`
	`670`	`+# - <i>Italicized words</i> in a list item.`
`671`	`671`	`#`
`672`		`-# ====== <i>Two words</i> in a Heading`
	`672`	`+# ====== <i>Italicized words</i> in a Heading`
`673`	`673`	`#`
`674`	`674`	`# <i>Italicized passage containing bold and +monofont+.</i>`
`675`	`675`	`#`
`@@ -678,58 +678,54 @@`
`678`	`678`	`#`
`679`	`679`	`# Example input:`
`680`	`680`	`#`
`681`		`-# _Word_ in a paragraph.`
	`681`	`+# _Italic_ in a paragraph.`
`682`	`682`	`#`
`683`	`683`	`# >>>`
`684`		`-# _Word_ in a block quote.`
	`684`	`+# _Italic_ in a block quote.`
`685`	`685`	`#`
`686`		`-# - _Word_ in a bullet list item.`
	`686`	`+# - _Italic_ in a list item.`
`687`	`687`	`#`
`688`		`-# [_word_] _Word_ in a labeled list item.`
`689`		`-#`
`690`		`-# ====== _Word_ in a Heading`
	`688`	`+# ====== _Italic_ in a Heading`
`691`	`689`	`#`
`692`	`690`	`# Rendered HTML:`
`693`	`691`	`# >>>`
`694`		`-# _Word_ in a paragraph.`
	`692`	`+# _Italic_ in a paragraph.`
`695`	`693`	`#`
`696`	`694`	`# >>>`
`697`		`-# _Word_ in a block quote.`
`698`		`-#`
`699`		`-# - _Word_ in a bullet list item.`
	`695`	`+# _Italic_ in a block quote.`
`700`	`696`	`#`
`701`		`-# [_word_] _Word_ in a labeled list item.`
	`697`	`+# - _Italic_ in a list item.`
`702`	`698`	`#`
`703`		`-# ====== _Word_ in a Heading`
	`699`	`+# ====== _Italic_ in a Heading`
`704`	`700`	`#`
`705`	`701`	`# ===== Bold`
`706`	`702`	`#`
`707`	`703`	`# Text may be marked as bold via HTML tag <tt><b></tt>.`
`708`	`704`	`#`
`709`	`705`	`# Example input:`
`710`	`706`	`#`
`711`		`-# <b>Two words</b> in a paragraph.`
	`707`	`+# <b>Bold words</b> in a paragraph.`
`712`	`708`	`#`
`713`	`709`	`# >>>`
`714`		`-# <b>Two words</b> in a block quote.`
	`710`	`+# <b>Bold words</b> in a block quote.`
`715`	`711`	`#`
`716`		`-# - <b>Two words</b> in a bullet list item.`
	`712`	`+# - <b>Bold words</b> in a list item.`
`717`	`713`	`#`
`718`		`-# ====== <b>Two words</b> in a Heading`
	`714`	`+# ====== <b>Bold words</b> in a Heading`
`719`	`715`	`#`
`720`	`716`	`# <b>Bold passage containing _italics_ and +monofont+.</b>`
`721`	`717`	`#`
`722`	`718`	`# Rendered HTML:`
`723`	`719`	`#`
`724`	`720`	`# >>>`
`725`		`-# <b>Two words</b> in a paragraph.`
	`721`	`+# <b>Bold words</b> in a paragraph.`
`726`	`722`	`#`
`727`	`723`	`# >>>`
`728`		`-# <b>Two words</b> in a block quote.`
	`724`	`+# <b>Bold words</b> in a block quote.`
`729`	`725`	`#`
`730`		`-# - <b>Two words</b> in a bullet list item.`
	`726`	`+# - <b>Bold words</b> in a list item.`
`731`	`727`	`#`
`732`		`-# ====== <b>Two words</b> in a Heading`
	`728`	`+# ====== <b>Bold words</b> in a Heading`
`733`	`729`	`#`
`734`	`730`	`# <b>Bold passage containing _italics_ and +monofont+.</b>`
`735`	`731`	`#`
`@@ -738,30 +734,26 @@`
`738`	`734`	`#`
`739`	`735`	`# Example input:`
`740`	`736`	`#`
`741`		`-# Word in a paragraph.`
	`737`	`+# Bold in a paragraph.`
`742`	`738`	`#`
`743`	`739`	`# >>>`
`744`		`-# Word in a block quote.`
	`740`	`+# Bold in a block quote.`
`745`	`741`	`#`
`746`		`-# - Word in a bullet list item.`
	`742`	`+# - Bold in a list item.`
`747`	`743`	`#`
`748`		`-# [word] Word in a labeled list item.`
`749`		`-#`
`750`		`-# ===== Word in a Heading`
	`744`	`+# ===== Bold in a Heading`
`751`	`745`	`#`
`752`	`746`	`# Rendered HTML:`
`753`	`747`	`#`
`754`	`748`	`# >>>`
`755`		`-# Word in a paragraph.`
	`749`	`+# Bold in a paragraph.`
`756`	`750`	`#`
`757`	`751`	`# >>>`
`758`		`-# Word in a block quote.`
`759`		`-#`
`760`		`-# - Word in a bullet list item.`
	`752`	`+# Bold in a block quote.`
`761`	`753`	`#`
`762`		`-# [word] Word in a labeled list item.`
	`754`	`+# - Bold in a list item.`
`763`	`755`	`#`
`764`		`-# ===== Word in a Heading`
	`756`	`+# ===== Bold in a Heading`
`765`	`757`	`#`
`766`	`758`	`# ===== Monofont`
`767`	`759`	`#`
`@@ -771,28 +763,28 @@`
`771`	`763`	`#`
`772`	`764`	`# Example input:`
`773`	`765`	`#`
`774`		`-# <tt>Two words</tt> in a paragraph.`
	`766`	`+# <tt>Monofont words</tt> in a paragraph.`
`775`	`767`	`#`
`776`	`768`	`# >>>`
`777`		`-# <tt>Two words</tt> in a block quote.`
	`769`	`+# <tt>Monofont words</tt> in a block quote.`
`778`	`770`	`#`
`779`		`-# - <tt>Two words</tt> in a bullet list item.`
	`771`	`+# - <tt>Monofont words</tt> in a list item.`
`780`	`772`	`#`
`781`		`-# ====== <tt>Two words</tt> in heading`
	`773`	`+# ====== <tt>Monofont words</tt> in heading`
`782`	`774`	`#`
`783`	`775`	`# <tt>Monofont passage containing _italics_ and bold.</tt>`
`784`	`776`	`#`
`785`	`777`	`# Rendered HTML:`
`786`	`778`	`#`
`787`	`779`	`# >>>`
`788`		`-# <tt>Two words</tt> in a paragraph.`
	`780`	`+# <tt>Monofont words</tt> in a paragraph.`
`789`	`781`	`#`
`790`	`782`	`# >>>`
`791`		`-# <tt>Two words</tt> in a block quote.`
	`783`	`+# <tt>Monofont words</tt> in a block quote.`
`792`	`784`	`#`
`793`		`-# - <tt>Two words</tt> in a bullet list item.`
	`785`	`+# - <tt>Monofont words</tt> in a list item.`
`794`	`786`	`#`
`795`		`-# ====== <tt>Two words</tt> in heading`
	`787`	`+# ====== <tt>Monofont words</tt> in heading`
`796`	`788`	`#`
`797`	`789`	`# <tt>Monofont passage containing _italics_ and bold.</tt>`
`798`	`790`	`#`
`@@ -801,26 +793,26 @@`
`801`	`793`	`#`
`802`	`794`	`# Example input:`
`803`	`795`	`#`
`804`		`-# +Word+ in a paragraph.`
	`796`	`+# +Monofont+ in a paragraph.`
`805`	`797`	`#`
`806`	`798`	`# >>>`
`807`		`-# +Word+ in a block quote.`
	`799`	`+# +Monofont+ in a block quote.`
`808`	`800`	`#`
`809`		`-# - +Word+ in a bullet list item.`
	`801`	`+# - +Monofont+ in a list item.`
`810`	`802`	`#`
`811`		`-# ====== +Word+ in a Heading`
	`803`	`+# ====== +Monofont+ in a Heading`
`812`	`804`	`#`
`813`	`805`	`# Rendered HTML:`
`814`	`806`	`#`
`815`	`807`	`# >>>`
`816`		`-# +Word+ in a paragraph.`
	`808`	`+# +Monofont+ in a paragraph.`
`817`	`809`	`#`
`818`	`810`	`# >>>`
`819`		`-# +Word+ in a block quote.`
	`811`	`+# +Monofont+ in a block quote.`
`820`	`812`	`#`
`821`		`-# - +Word+ in a bullet list item.`
	`813`	`+# - +Monofont+ in a list item.`
`822`	`814`	`#`
`823`		`-# ====== +Word+ in a Heading`
	`815`	`+# ====== +Monofont+ in a Heading`
`824`	`816`	`#`
`825`	`817`	`# ==== Escaping Text Markup`
`826`	`818`	`#`