Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOC] Improvements to Text Markup examples #915

Merged
merged 1 commit into from
Aug 11, 2022
Merged

[DOC] Improvements to Text Markup examples #915

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 48 additions & 56 deletions doc/rdoc/markup_reference.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
#
Expand All @@ -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>
#
Expand All @@ -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
#
Expand All @@ -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>
#
Expand All @@ -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
#
Expand Down