git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
Cc: git@vger.kernel.org, Jonathan Nieder <jrnieder@gmail.com>
Subject: Re: [PATCH v2] doc: camelCase the config variables to improve readability
Date: Sun, 24 Sep 2017 09:28:05 +0900	[thread overview]
Message-ID: <xmqqmv5lhre2.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <20170923045617.3782-1-kaarticsivaraam91196@gmail.com> (Kaartic Sivaraam's message of "Sat, 23 Sep 2017 10:26:17 +0530")

Kaartic Sivaraam <kaarticsivaraam91196@gmail.com> writes:

> A few configuration variable names of Git are composite words. References
> to such variables in manpages are hard to read because they use all-lowercase
> names, without indicating where each word ends and begins.
>
> Improve its readability by using camelCase instead.  Git treats these
> names case-insensitively so this does not affect functionality. This
> also ensures consistency with other parts of the docs that use camelCase
> fo refer to configuration variable names.

s/fo/to/ (or s/fo/in order to/)?  

I think the one I have on 'pu' uses Jonathan's suggested rewrite of
the log message verbatim, and I suspect that it is already clear
enough, even though I admit that I stuttered a bit while reading its
first sentence.

I'd avoid "A few" above, as it is my impression that we use
multi-word names quite a bit, not just a few.

Perhaps

	References to multi-word configuration variable names in our
	documentation must consistently use camelCase to highlight
	where the word boundaries are, even though these are treated
	case insensitively.

	Fix a few places that spell them in all lowercase, which
	makes them harder to read.

may be a more succinct way to say the same thing.  We state the rule
upfront, explain what the rule is for, and tell the codebase to
apply the rule.  That should cover everything your version and
Jonathan's version wanted to convey, I'd think.


  reply	other threads:[~2017-09-24  0:28 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-09-19 12:46 [PATCH] doc: camelCase the config variables to improve readability Kaartic Sivaraam
2017-09-19 20:22 ` Jonathan Nieder
2017-09-20  8:03   ` Kaartic Sivaraam
2017-09-23  4:56   ` [PATCH v2] " Kaartic Sivaraam
2017-09-24  0:28     ` Junio C Hamano [this message]
2017-09-24  5:21       ` Kaartic Sivaraam
2017-09-25  8:27       ` [PATCH v3] " Kaartic Sivaraam
  -- strict thread matches above, loose matches on Subject: below --
2017-09-20  5:27 [PATCH v2] for_each_string_list_item: avoid undefined behavior for empty list Jonathan Nieder
2017-09-20 12:22 ` [PATCH v2] doc: camelCase the config variables to improve readability Kaartic Sivaraam

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

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqmv5lhre2.fsf@gitster.mtv.corp.google.com \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=jrnieder@gmail.com \
    --cc=kaarticsivaraam91196@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.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).