From: Dragan Simic <dsimic@manjaro.org>
To: Junio C Hamano <gitster@pobox.com>
Cc: "Josh Soref via GitGitGadget" <gitgitgadget@gmail.com>,
git@vger.kernel.org, "Elijah Newren" <newren@gmail.com>,
"René Scharfe" <l.s.r@web.de>,
"Phillip Wood" <phillip.wood123@gmail.com>,
"Josh Soref" <jsoref@gmail.com>
Subject: Re: [PATCH v2 1/9] CodingGuidelines: move period inside parentheses
Date: Fri, 22 Dec 2023 02:30:01 +0100 [thread overview]
Message-ID: <b3b03da0e33b805f1f420a0dc1a19d86@manjaro.org> (raw)
In-Reply-To: <xmqqedffl13r.fsf@gitster.g>
On 2023-12-21 22:03, Junio C Hamano wrote:
> "Josh Soref via GitGitGadget" <gitgitgadget@gmail.com> writes:
>
>> From: Josh Soref <jsoref@gmail.com>
>>
>> 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.
>
> Nobody seems to have commented on this one in the previous round,
> but quite honestly, for this particular instance, I suspect that it
> may become easier to read if we just lost these parentheses, as the
> next sentence "You do not have to include more than ..." is just a
> bit of extra material to support the first sentence like the one we
> see in the parentheses. Alternatively, moving that "You do not have
> to" also inside the same parentheses might work slightly better.
I agree with simply erasing the parentheses, it makes the paragraph flow
much better.
> It might be even easier to follow if we moved the list of "approved
> headers" (and the "You do not have to ... more than one" note that
> supports the "currently approved list") totally out of line by
> making it a side note.
>
>> Signed-off-by: Josh Soref <jsoref@gmail.com>
>> ---
>> Documentation/CodingGuidelines | 2 +-
>> 1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/CodingGuidelines
>> b/Documentation/CodingGuidelines
>> index 8ed517a5ca0..af94ed3a75d 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
next prev parent reply other threads:[~2023-12-22 1:30 UTC|newest]
Thread overview: 55+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-19 8:41 [PATCH 0/8] Minor improvements to CodingGuidelines and SubmittingPatches Josh Soref via GitGitGadget
2023-12-19 8:41 ` [PATCH 1/8] CodingGuidelines: move period inside parentheses Josh Soref via GitGitGadget
2023-12-19 8:41 ` [PATCH 2/8] CodingGuidelines: write punctuation marks Josh Soref via GitGitGadget
2023-12-19 8:41 ` [PATCH 3/8] SubmittingPatches: drop ref to "What's in git.git" Josh Soref via GitGitGadget
2023-12-19 8:41 ` [PATCH 4/8] SubmittingPatches: update extra tags list Josh Soref via GitGitGadget
2023-12-20 15:18 ` Phillip Wood
2023-12-20 15:30 ` Elijah Newren
2023-12-20 16:09 ` Josh Soref
2023-12-20 16:49 ` Elijah Newren
2023-12-20 17:42 ` Josh Soref
2023-12-21 15:09 ` phillip.wood123
2023-12-20 16:31 ` Junio C Hamano
2023-12-19 8:41 ` [PATCH 5/8] SubmittingPatches: improve extra tags advice Josh Soref via GitGitGadget
2023-12-19 8:41 ` [PATCH 6/8] SubmittingPatches: clarify GitHub visual Josh Soref via GitGitGadget
2023-12-19 14:44 ` René Scharfe
2023-12-20 15:40 ` Elijah Newren
2023-12-20 16:25 ` Josh Soref
2023-12-20 16:39 ` Junio C Hamano
2023-12-19 8:41 ` [PATCH 7/8] SubmittingPatches: clarify GitHub artifact format Josh Soref via GitGitGadget
2023-12-20 15:21 ` Elijah Newren
2023-12-20 16:16 ` Josh Soref
2023-12-20 17:00 ` Elijah Newren
2023-12-19 8:41 ` [PATCH 8/8] SubmittingPatches: hyphenate non-ASCII Josh Soref via GitGitGadget
2023-12-20 15:43 ` [PATCH 0/8] Minor improvements to CodingGuidelines and SubmittingPatches Elijah Newren
2023-12-21 16:40 ` [PATCH v2 0/9] " Josh Soref via GitGitGadget
2023-12-21 16:40 ` [PATCH v2 1/9] CodingGuidelines: move period inside parentheses Josh Soref via GitGitGadget
2023-12-21 21:03 ` Junio C Hamano
2023-12-21 21:52 ` Josh Soref
2023-12-22 1:30 ` Dragan Simic [this message]
2023-12-21 16:40 ` [PATCH v2 2/9] CodingGuidelines: write punctuation marks Josh Soref via GitGitGadget
2023-12-21 20:57 ` Junio C Hamano
2023-12-21 21:46 ` Josh Soref
2023-12-21 21:57 ` Junio C Hamano
2023-12-21 16:40 ` [PATCH v2 3/9] SubmittingPatches: drop ref to "What's in git.git" Josh Soref via GitGitGadget
2023-12-21 21:09 ` Junio C Hamano
2023-12-21 16:41 ` [PATCH v2 4/9] SubmittingPatches: discourage new trailers Josh Soref via GitGitGadget
2023-12-21 16:41 ` [PATCH v2 5/9] SubmittingPatches: update extra tags list Josh Soref via GitGitGadget
2023-12-21 21:16 ` Junio C Hamano
2023-12-21 21:55 ` Josh Soref
2023-12-21 16:41 ` [PATCH v2 6/9] SubmittingPatches: improve extra tags advice Josh Soref via GitGitGadget
2023-12-21 21:18 ` Junio C Hamano
2023-12-21 16:41 ` [PATCH v2 7/9] SubmittingPatches: clarify GitHub visual Josh Soref via GitGitGadget
2023-12-21 21:27 ` Junio C Hamano
2023-12-21 16:41 ` [PATCH v2 8/9] SubmittingPatches: clarify GitHub artifact format Josh Soref via GitGitGadget
2023-12-21 16:41 ` [PATCH v2 9/9] SubmittingPatches: hyphenate non-ASCII Josh Soref via GitGitGadget
2023-12-28 4:55 ` [PATCH v3 0/9] Minor improvements to CodingGuidelines and SubmittingPatches Josh Soref via GitGitGadget
2023-12-28 4:55 ` [PATCH v3 1/9] CodingGuidelines: move period inside parentheses Josh Soref via GitGitGadget
2023-12-28 4:55 ` [PATCH v3 2/9] CodingGuidelines: write punctuation marks Josh Soref via GitGitGadget
2023-12-28 4:55 ` [PATCH v3 3/9] SubmittingPatches: drop ref to "What's in git.git" Josh Soref via GitGitGadget
2023-12-28 4:55 ` [PATCH v3 4/9] SubmittingPatches: discourage new trailers Josh Soref via GitGitGadget
2023-12-28 4:55 ` [PATCH v3 5/9] SubmittingPatches: update extra tags list Josh Soref via GitGitGadget
2023-12-28 4:55 ` [PATCH v3 6/9] SubmittingPatches: provide tag naming advice Josh Soref via GitGitGadget
2023-12-28 4:55 ` [PATCH v3 7/9] SubmittingPatches: clarify GitHub visual Josh Soref via GitGitGadget
2023-12-28 4:55 ` [PATCH v3 8/9] SubmittingPatches: clarify GitHub artifact format Josh Soref via GitGitGadget
2023-12-28 4:55 ` [PATCH v3 9/9] SubmittingPatches: hyphenate non-ASCII Josh Soref via GitGitGadget
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=b3b03da0e33b805f1f420a0dc1a19d86@manjaro.org \
--to=dsimic@manjaro.org \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
--cc=jsoref@gmail.com \
--cc=l.s.r@web.de \
--cc=newren@gmail.com \
--cc=phillip.wood123@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).