From 2d194548cb8c16d17925be0f0e8ce946eb6d1f6e Mon Sep 17 00:00:00 2001 From: Josh Soref Date: Thu, 28 Dec 2023 04:55:16 +0000 Subject: CodingGuidelines: move period inside parentheses The contents within parenthesis should be omittable without resulting in broken text. Eliding the parenthesis left a period to end a run without any content. Signed-off-by: Josh Soref Signed-off-by: Junio C Hamano --- Documentation/CodingGuidelines | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/CodingGuidelines') diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 8d3a467c01..b64e52fdbe 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -450,7 +450,7 @@ For C programs: one of the approved headers that includes it first for you. (The approved headers currently include "builtin.h", "t/helper/test-tool.h", "xdiff/xinclude.h", or - "reftable/system.h"). You do not have to include more than one of + "reftable/system.h".) You do not have to include more than one of these. - A C file must directly include the header files that declare the -- cgit v1.2.3 From e6397c5cc83979d4808e9aeeb0276d3302987782 Mon Sep 17 00:00:00 2001 From: Josh Soref Date: Thu, 28 Dec 2023 04:55:17 +0000 Subject: CodingGuidelines: write punctuation marks - Match style in Release Notes Signed-off-by: Josh Soref Signed-off-by: Junio C Hamano --- Documentation/CodingGuidelines | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/CodingGuidelines') diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index b64e52fdbe..169d4eb3ac 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -578,7 +578,7 @@ Externally Visible Names . The variable name describes the effect of tweaking this knob. The section and variable names that consist of multiple words are - formed by concatenating the words without punctuations (e.g. `-`), + formed by concatenating the words without punctuation marks (e.g. `-`), and are broken using bumpyCaps in documentation as a hint to the reader. -- cgit v1.2.3