Skip to content

Commit 188fdbe

Browse files
committed
Merge branch 'cf/guideline-documenting-config-vars' into jch
CodingGuidelines update. * cf/guideline-documenting-config-vars: CodingGuidelines: document formatting of similar config variables.
2 parents 1717f72 + 249c179 commit 188fdbe

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

Documentation/CodingGuidelines

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -877,6 +877,17 @@ Characters are also surrounded by underscores:
877877
As a side effect, backquoted placeholders are correctly typeset, but
878878
this style is not recommended.
879879

880+
When documenting multiple related `git config` variables, place them on
881+
a separate line instead of separating them by commas. For example, do
882+
not write this:
883+
`core.var1`, `core.var2`::
884+
Description common to `core.var1` and `core.var2`.
885+
886+
Instead write this:
887+
`core.var1`::
888+
`core.var2`::
889+
Description common to `core.var1` and `core.var2`.
890+
880891
Synopsis Syntax
881892

882893
The synopsis (a paragraph with [synopsis] attribute) is automatically

0 commit comments

Comments
 (0)