Skip to content

Commit 9ce1ca3

Browse files
committed
Merge branch 'ja/doc-placeholders-markup-rules' into HEAD
The way placeholders are to be marked-up in documentation have been specified; use "_<placeholder>_" to typeset the word inside a pair of <angle-brakets> emphasized. * ja/doc-placeholders-markup-rules: doc: clarify the format of placeholders
2 parents 510a27e + 0824639 commit 9ce1ca3

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

Documentation/CodingGuidelines

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -666,6 +666,11 @@ Writing Documentation:
666666
<new-branch-name>
667667
--template=<template-directory>
668668

669+
When a placeholder is cited in text paragraph, it is enclosed in angle
670+
brackets to remind the reader the reference in the synopsis section.
671+
For better visibility, the placeholder is typeset in italics:
672+
The _<file>_ to be added.
673+
669674
Possibility of multiple occurrences is indicated by three dots:
670675
<file>...
671676
(One or more of <file>.)
@@ -751,6 +756,8 @@ Writing Documentation:
751756
Incorrect:
752757
`\--pretty=oneline`
753758

759+
A placeholder is not enclosed in backticks, as it is not a literal.
760+
754761
If some place in the documentation needs to typeset a command usage
755762
example with inline substitutions, it is fine to use +monospaced and
756763
inline substituted text+ instead of `monospaced literal text`, and with

0 commit comments

Comments
 (0)