mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
Adapt doc guide to new GFM features (#6504)
* Adapt doc guide to new GFM features * Adapt doc guide to new GFM features
This commit is contained in:
parent
43650f606e
commit
7837dccb0e
Notes:
git
2022-10-07 05:02:59 +09:00
Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
1 changed files with 4 additions and 6 deletions
|
@ -159,8 +159,8 @@ may not render them properly.
|
||||||
|
|
||||||
### Tables
|
### Tables
|
||||||
|
|
||||||
Avoid building tables with HTML tags
|
In particular, avoid building tables with HTML tags
|
||||||
(<tt><table></tt>, etc.)
|
(<tt><table></tt>, etc.).
|
||||||
|
|
||||||
Alternatives are:
|
Alternatives are:
|
||||||
|
|
||||||
|
@ -170,10 +170,8 @@ Alternatives are:
|
||||||
|
|
||||||
- A {verbatim text block}[rdoc-ref:RDoc::MarkupReference@Verbatim+Text+Blocks],
|
- A {verbatim text block}[rdoc-ref:RDoc::MarkupReference@Verbatim+Text+Blocks],
|
||||||
using spaces and punctuation to format the text.
|
using spaces and punctuation to format the text.
|
||||||
|
Note that {text markup}[rdoc-ref:RDoc::MarkupReference@Text+Markup]
|
||||||
Note that in neither case will
|
will not be honored.
|
||||||
{text markup}[rdoc-ref:RDoc::MarkupReference@Text+Markup]
|
|
||||||
be honored.
|
|
||||||
|
|
||||||
## Documenting Classes and Modules
|
## Documenting Classes and Modules
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue