git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "Nils Leif Fischer via GitGitGadget" <gitgitgadget@gmail.com>
Cc: Derrick Stolee <dstolee@microsoft.com>,
	git@vger.kernel.org, Nils Leif Fischer <hello@nilsleiffischer.de>,
	Nils Leif Fischer <nils.fischer@aei.mpg.de>
Subject: Re: [PATCH] Fix a typo in git-maintenance documentation
Date: Fri, 19 Mar 2021 13:19:41 -0700	[thread overview]
Message-ID: <xmqqa6qynbfm.fsf@gitster.g> (raw)
In-Reply-To: <xmqqv99nm3jy.fsf@gitster.g> (Junio C. Hamano's message of "Fri, 19 Mar 2021 10:55:13 -0700")

Junio C Hamano <gitster@pobox.com> writes:

>>  gc::
>>  	Clean up unnecessary files and optimize the local repository. "GC"
>> -	stands for "garbage collection," but this task performs many
>> +	stands for "garbage collection", but this task performs many
>
> Isn't this merely an American style vs British style issue?

Having said that, I think a lot of existing documentation (and my
gut feeling says "majority of", but I cannot claim anything like
that without actually counting [*1*]) we have tend to stick to the
"punctuation outside" British style [*2*].

If somebody (not me, and probably not Derrick) is willing to do the
counting and tree-wide style fixes, I am OK if we add some new text
to Documentation/CodingGuidelines to declare which style we stick
to, and enforce consistency throughout the documentation set.


[Footnote]

*1* A quick count:

    $ git grep -e '," ' Documentation/

    gives just a single hit.  On the other hand, '", ' hits too many,
    but many are sentences like 

      "git clone -q", "git fetch -q", and the like are quiet.

    which is not quite fair.

    Don't try to do that for the comma replaced with period; you'd be
    buried by "word..."  and the like.


*2* After all, that is more "logical", for us CS types---opening and
    closing quotes pair with each other, and the punctuation that
    appears near the quoted portion is part of the larger sentence
    structure.

  parent reply	other threads:[~2021-03-19 20:20 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-19 10:17 [PATCH] Fix a typo in git-maintenance documentation Nils Leif Fischer via GitGitGadget
2021-03-19 17:55 ` Junio C Hamano
2021-03-19 18:37   ` Derrick Stolee
2021-03-19 20:19   ` Junio C Hamano [this message]
2021-03-20  1:55     ` Derrick Stolee

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=xmqqa6qynbfm.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=dstolee@microsoft.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=hello@nilsleiffischer.de \
    --cc=nils.fischer@aei.mpg.de \
    /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).