Skip to content

Commit c089e7c

Browse files
committed
style: Backtick DOC_FILES, _N, and N.
These are literal quotes, and we don't want Markdown to confuse the underscores with emphasis delimiters [1]. [1]: http://daringfireball.net/projects/markdown/syntax#em Signed-off-by: W. Trevor King <[email protected]>
1 parent d87ec69 commit c089e7c

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

style.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The use of referenced links in the markdown body helps to keep files clean and o
3232
This also facilitates updates of external link targets on a per-file basis.
3333

3434
Referenced links should be kept in two alphabetically sorted sets, a general reference section followed by a man page section.
35-
To keep Pandoc happy, duplicate naming of links within pages listed in the Makefile's DOC_FILES variable should be avoided by appending an '_N' to the link tagname, where 'N' is some number not currently in use.
35+
To keep Pandoc happy, duplicate naming of links within pages listed in the Makefile's `DOC_FILES` variable should be avoided by appending an `_N` to the link tagname, where `N` is some number not currently in use.
3636
The organization and style of an existing reference section should be maintained unless it violates these style guidelines.
3737

3838
An exception to these rules is when a URL is needed contextually, for example when showing an explicit link to the reader.

0 commit comments

Comments
 (0)