diff options
| author | Burdette Lamar <BurdetteLamar@Yahoo.com> | 2022-10-06 15:02:37 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-06 15:02:37 -0500 |
| commit | 7837dccb0ea9f84f033635e77bc9dfb6ea023bcd (patch) | |
| tree | ceed99e5377530ceb379e85ec8c149bdddb49551 /doc | |
| parent | 43650f606e221f0c8029c0795458e39c740b2c30 (diff) | |
Adapt doc guide to new GFM features (#6504)
* Adapt doc guide to new GFM features
* Adapt doc guide to new GFM features
Notes
Notes:
Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/contributing/documentation_guide.md | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/doc/contributing/documentation_guide.md b/doc/contributing/documentation_guide.md index 6090928edf..e8a5c5e478 100644 --- a/doc/contributing/documentation_guide.md +++ b/doc/contributing/documentation_guide.md @@ -159,8 +159,8 @@ may not render them properly. ### Tables -Avoid building tables with HTML tags -(<tt><table></tt>, etc.) +In particular, avoid building tables with HTML tags +(<tt><table></tt>, etc.). Alternatives are: @@ -170,10 +170,8 @@ Alternatives are: - A {verbatim text block}[rdoc-ref:RDoc::MarkupReference@Verbatim+Text+Blocks], using spaces and punctuation to format the text. - -Note that in neither case will -{text markup}[rdoc-ref:RDoc::MarkupReference@Text+Markup] -be honored. + Note that {text markup}[rdoc-ref:RDoc::MarkupReference@Text+Markup] + will not be honored. ## Documenting Classes and Modules |