CodingGuidelines: document formatting of similar config variables.
Document that related `git config` variables should be placed one-per-line instead of separated by commas. Suggested-by: Junio C Hamano <gitster@pobox.com> Signed-off-by: Collin Funk <collin.funk1@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Collin Funk committed
Jun 3, 2025 at 15:45 UTC
ff67eea529b450293b19182386b48d317895a414
1 file changed
+11
Documentation/CodingGuidelines
+11
@@ -874,6 +874,17 @@ Markup:
874
As a side effect, backquoted placeholders are correctly typeset, but
875
this style is not recommended.
876
877
+ When documenting multiple related `git config` variables, place them on
878
+ a separate line instead of separating them by commas. For example, do
879
+ not write this:
880
+ `core.var1`, `core.var2`::
881
+ Description common to `core.var1` and `core.var2`.
882
+
883
+Instead write this:
884
+ `core.var1`::
885
+ `core.var2`::
886
+ Description common to `core.var1` and `core.var2`.
887
+
888
Synopsis Syntax
889
890
The synopsis (a paragraph with [synopsis] attribute) is automatically