Skip to content

Commit 7837dcc

Browse files
Adapt doc guide to new GFM features (#6504)
* Adapt doc guide to new GFM features * Adapt doc guide to new GFM features
1 parent 43650f6 commit 7837dcc

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

doc/contributing/documentation_guide.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -159,8 +159,8 @@ may not render them properly.
159159
160160
### Tables
161161
162-
Avoid building tables with HTML tags
163-
(<tt><table></tt>, etc.)
162+
In particular, avoid building tables with HTML tags
163+
(<tt><table></tt>, etc.).
164164
165165
Alternatives are:
166166
@@ -170,10 +170,8 @@ Alternatives are:
170170
171171
- A {verbatim text block}[rdoc-ref:RDoc::MarkupReference@Verbatim+Text+Blocks],
172172
using spaces and punctuation to format the text.
173-
174-
Note that in neither case will
175-
{text markup}[rdoc-ref:RDoc::MarkupReference@Text+Markup]
176-
be honored.
173+
Note that {text markup}[rdoc-ref:RDoc::MarkupReference@Text+Markup]
174+
will not be honored.
177175
178176
## Documenting Classes and Modules
179177

0 commit comments

Comments
 (0)