We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
2 parents f9aa0ee + ff67eea commit f1a1d79Copy full SHA for f1a1d79
Documentation/CodingGuidelines
@@ -877,6 +877,17 @@ Characters are also surrounded by underscores:
877
As a side effect, backquoted placeholders are correctly typeset, but
878
this style is not recommended.
879
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
890
891
Synopsis Syntax
892
893
The synopsis (a paragraph with [synopsis] attribute) is automatically
0 commit comments