Skip to content

Commit 5506d4d

Browse files
Mods to section Text Markup (#916)
1 parent d00ddfe commit 5506d4d

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

doc/rdoc/markup_reference.rb

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@
9494
# - {Directive}[rdoc-ref:RDoc::MarkupReference@Directives]:
9595
# various special directions for the rendering.
9696
# - {Text Markup}[rdoc-ref:RDoc:MarkupReference@Text+Markup]:
97-
# text to be rendered in italic, bold, or monofont.
97+
# text to be rendered in a special way.
9898
#
9999
# About the blocks:
100100
#
@@ -632,18 +632,24 @@
632632
#
633633
# ==== Text Markup
634634
#
635-
# Text markup is metatext that marks text as:
635+
# Text markup is metatext that affects HTML rendering:
636636
#
637-
# - Italic.
638-
# - Bold.
639-
# - Monofont.
637+
# - Typeface: italic, bold, monofont.
638+
# - Character conversions: copyright, trademark, certain punctuation.
639+
# - Links.
640+
# - Escapes: marking text as "not markup."
640641
#
641-
# Text markup may contain only one type of nested block:
642+
# ===== Typeface Markup
642643
#
643-
# - More text markup:
644+
# Typeface markup can specify that text is to be rendered
645+
# as italic, bold, or monofont.
646+
#
647+
# Typeface markup may contain only one type of nested block:
648+
#
649+
# - More typeface markup:
644650
# italic, bold, monofont.
645651
#
646-
# ===== Italic
652+
# ====== Italic
647653
#
648654
# Text may be marked as italic via HTML tag <tt><i></tt> or <tt><em></tt>.
649655
#
@@ -698,7 +704,7 @@
698704
#
699705
# ====== _Italic_ in a Heading
700706
#
701-
# ===== Bold
707+
# ====== Bold
702708
#
703709
# Text may be marked as bold via HTML tag <tt><b></tt>.
704710
#
@@ -755,7 +761,7 @@
755761
#
756762
# ===== *Bold* in a Heading
757763
#
758-
# ===== Monofont
764+
# ====== Monofont
759765
#
760766
# Text may be marked as monofont
761767
# -- sometimes called 'typewriter font' --

0 commit comments

Comments
 (0)