diff options
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 |