From 7837dccb0ea9f84f033635e77bc9dfb6ea023bcd Mon Sep 17 00:00:00 2001 From: Burdette Lamar Date: Thu, 6 Oct 2022 15:02:37 -0500 Subject: [PATCH] Adapt doc guide to new GFM features (#6504) * Adapt doc guide to new GFM features * Adapt doc guide to new GFM features --- doc/contributing/documentation_guide.md | 10 ++++------ 1 file 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 -(, etc.) +In particular, avoid building tables with HTML tags +(
, 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