diff --git a/doc/markup_reference/rdoc.rdoc b/doc/markup_reference/rdoc.rdoc index cbb48fdbaf..7e26e8d85a 100644 --- a/doc/markup_reference/rdoc.rdoc +++ b/doc/markup_reference/rdoc.rdoc @@ -549,7 +549,7 @@ and :enddoc: may appear in a stand-alone comment: ==== :markup: -- Appears on a line by itself; takes argument +format+ (:markup: _format_). +- Appears on a line by itself; takes argument +format+ (:markup: format). - Specifies the format for the RDoc input; argument +format+ is one of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+. @@ -574,7 +574,7 @@ For C code, the directive may appear in a stand-alone comment. ==== :args: -- Appears on a line by itself; takes argument +arg_names+ (:args: _arg_names_). +- Appears on a line by itself; takes argument +arg_names+ (:args: arg_names). - Specifies the arguments to be reported in the HTML, overriding the actual arguments in the code. See RDoc::Example#args_example for a demonstration. @@ -583,7 +583,7 @@ Aliased as :arg:. ==== :yields: -- Appears on a line by itself; takes argument +arg_names+ (:yields: _arg_names_). +- Appears on a line by itself; takes argument +arg_names+ (:yields: arg_names). - Specifies the yield arguments to be reported in the HTML, overriding the actual yield in the code. See RDoc::Example#yields_example for a demonstration. @@ -602,7 +602,7 @@ You can use directives to modify those behaviors. ==== :section: -- Appears on a line by itself; takes argument +section_title+ (:section: _section_title_). +- Appears on a line by itself; takes argument +section_title+ (:section: section_title). - Specifies that following methods are to be grouped into the section with the given +section_title+, or into the default section if no title is given. @@ -638,7 +638,7 @@ override the current section. ==== :category: -- Appears on a line by itself; takes argument +section_title+ (:category: _section_title_). +- Appears on a line by itself; takes argument +section_title+ (:category: section_title). - Specifies that just one following method is to be included in the given section, or in the default section if no title is given. Subsequent methods are to be grouped into the current section. @@ -647,7 +647,7 @@ override the current section. ==== :include: -- Appears on a line by itself; takes argument +filepath+ (:include: _filepath_). +- Appears on a line by itself; takes argument +filepath+ (:include: filepath). - Specifies that the contents of the given file are to be included at this point. @@ -746,14 +746,14 @@ Example input: Monofont words in a paragraph. - Monofont passage containing _italics_ and *bold*. + Monofont stylings are disabled: _italics_ and *bold*. Rendered HTML: >>> Monofont words in a paragraph. - Monofont passage containing _italics_ and *bold*. + Monofont stylings are disabled: _italics_ and *bold*. A single word may be made monofont by a shorthand: prefixed and suffixed plus-signs. @@ -1042,18 +1042,18 @@ Example input: This list is about escapes; it contains: - - Monofont text with unescaped nested _italic_. - - Monofont text with escaped nested \_italic_. - - Monofont text with an escape character \. + - Bold text with unescaped nested _italic_. + - Bold text with escaped nested \_italic_. + - Bold text with an escape character \. Rendered HTML: >>> This list is about escapes; it contains: - - Monofont text with unescaped nested _italic_. - - Monofont text with escaped nested \_italic_. - - Monofont text with an escape character \ . + - Bold text with unescaped nested _italic_. + - Bold text with escaped nested \_italic_. + - Bold text with an escape character \ . In other text-bearing blocks (paragraphs, block quotes, list items, headings):