Skip to content

Commit 19f2725

Browse files
authored
[DOC] Remove _italic_ *bold* styling inside codeblock (ruby#1552)
Styling in codeblock is already dropped as a bugfix (in ruby#1536) so that codeblock does not need to escape frequently used operators like `+`, `*`. Some document in ruby/ruby also uses `_italic_` inside `<tt>` tags and we should also fix them. For example, [ruby/ruby/doc/_regexp.rdoc](https://github.com/ruby/ruby/blob/25c72b0e8e206e5baec71d4ece7551b7da7da445/doc/_regexp.rdoc?plain=1#L417C1-L417C52) has `<tt>(?=_pat_)</tt>`
1 parent 4b9daa0 commit 19f2725

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

doc/markup_reference/rdoc.rdoc

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -549,7 +549,7 @@ and <tt>:enddoc:</tt> may appear in a stand-alone comment:
549549

550550
==== <tt>:markup:</tt>
551551

552-
- Appears on a line by itself; takes argument +format+ (<tt>:markup: _format_</tt>).
552+
- Appears on a line by itself; takes argument +format+ (<tt>:markup: format</tt>).
553553
- Specifies the format for the RDoc input;
554554
argument +format+ is one of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+.
555555

@@ -574,7 +574,7 @@ For C code, the directive may appear in a stand-alone comment.
574574

575575
==== <tt>:args:</tt>
576576

577-
- Appears on a line by itself; takes argument +arg_names+ (<tt>:args: _arg_names_</tt>).
577+
- Appears on a line by itself; takes argument +arg_names+ (<tt>:args: arg_names</tt>).
578578
- Specifies the arguments to be reported in the HTML,
579579
overriding the actual arguments in the code.
580580
See RDoc::Example#args_example for a demonstration.
@@ -583,7 +583,7 @@ Aliased as <tt>:arg:</tt>.
583583

584584
==== <tt>:yields:</tt>
585585

586-
- Appears on a line by itself; takes argument +arg_names+ (<tt>:yields: _arg_names_</tt>).
586+
- Appears on a line by itself; takes argument +arg_names+ (<tt>:yields: arg_names</tt>).
587587
- Specifies the yield arguments to be reported in the HTML,
588588
overriding the actual yield in the code.
589589
See RDoc::Example#yields_example for a demonstration.
@@ -602,7 +602,7 @@ You can use directives to modify those behaviors.
602602

603603
==== <tt>:section:</tt>
604604

605-
- Appears on a line by itself; takes argument +section_title+ (<tt>:section: _section_title_</tt>).
605+
- Appears on a line by itself; takes argument +section_title+ (<tt>:section: section_title</tt>).
606606
- Specifies that following methods are to be grouped into the section
607607
with the given +section_title+,
608608
or into the default section if no title is given.
@@ -638,7 +638,7 @@ override the current section.
638638

639639
==== <tt>:category:</tt>
640640

641-
- Appears on a line by itself; takes argument +section_title+ (<tt>:category: _section_title_</tt>).
641+
- Appears on a line by itself; takes argument +section_title+ (<tt>:category: section_title</tt>).
642642
- Specifies that just one following method is to be included
643643
in the given section, or in the default section if no title is given.
644644
Subsequent methods are to be grouped into the current section.
@@ -647,7 +647,7 @@ override the current section.
647647

648648
==== <tt>:include:</tt>
649649

650-
- Appears on a line by itself; takes argument +filepath+ (<tt>:include: _filepath_</tt>).
650+
- Appears on a line by itself; takes argument +filepath+ (<tt>:include: filepath</tt>).
651651
- Specifies that the contents of the given file
652652
are to be included at this point.
653653

@@ -746,14 +746,14 @@ Example input:
746746

747747
<tt>Monofont words</tt> in a paragraph.
748748

749-
<tt>Monofont passage containing _italics_ and *bold*.</tt>
749+
<tt>Monofont stylings are disabled: _italics_ and *bold*.</tt>
750750

751751
Rendered HTML:
752752

753753
>>>
754754
<tt>Monofont words</tt> in a paragraph.
755755

756-
<tt>Monofont passage containing _italics_ and *bold*.</tt>
756+
<tt>Monofont stylings are disabled: _italics_ and *bold*.</tt>
757757

758758
A single word may be made monofont by a shorthand:
759759
prefixed and suffixed plus-signs or backticks.
@@ -1057,18 +1057,18 @@ Example input:
10571057

10581058
This list is about escapes; it contains:
10591059

1060-
- <tt>Monofont text with unescaped nested _italic_</tt>.
1061-
- <tt>Monofont text with escaped nested \_italic_</tt>.
1062-
- <tt>Monofont text with an escape character \</tt>.
1060+
- <b>Bold text with unescaped nested _italic_</b>.
1061+
- <b>Bold text with escaped nested \_italic_</b>.
1062+
- <b>Bold text with an escape character \</b>.
10631063

10641064
Rendered HTML:
10651065

10661066
>>>
10671067
This list is about escapes; it contains:
10681068

1069-
- <tt>Monofont text with unescaped nested _italic_</tt>.
1070-
- <tt>Monofont text with escaped nested \_italic_</tt>.
1071-
- <tt>Monofont text with an escape character \ </tt>.
1069+
- <b>Bold text with unescaped nested _italic_</b>.
1070+
- <b>Bold text with escaped nested \_italic_</b>.
1071+
- <b>Bold text with an escape character \ </b>.
10721072

10731073
In other text-bearing blocks
10741074
(paragraphs, block quotes, list items, headings):

0 commit comments

Comments
 (0)