1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Adapt doc guide to new GFM features (#6504)

Browse Source 
* Adapt doc guide to new GFM features

* Adapt doc guide to new GFM features
This commit is contained in:
Burdette Lamar 2022-10-06 15:02:37 -05:00 committed by GitHub
parent 43650f606e
commit 7837dccb0e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/contributing/documentation_guide.md
View File

@ -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