public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed

From: Jonathan Nieder <jrnieder@gmail•com>
To: Kaartic Sivaraam <kaarticsivaraam91196@gmail•com>
Cc: git@vger•kernel.org
Subject: Re: [PATCH] doc: camelCase the config variables to improve readability
Date: Tue, 19 Sep 2017 13:22:01 -0700	[thread overview]
Message-ID: <20170919202201.GD75068@aiede.mtv.corp.google.com> (raw)
In-Reply-To: <0102015e9a2d3eb6-bee76ba8-4298-47d2-8822-d513bc33bd71-000000@eu-west-1.amazonses.com>

Hi,

Kaartic Sivaraam wrote:

> The config variable used weren't readable as they were in the
> crude form of how git stores/uses it's config variables.

nit: Git's commit messages describe the current behavior of Git in the
present tense.  Something like:

	These manpages' references to config variables are hard to read because
	they use all-lowercase names, without indicating where each word ends
	and begins in the configuration variable names.

	Improve readability by using camelCase instead.  Git treats these names
	case-insensitively so this does not affect functionality.

> Improve it's readability by replacing them with camelCased versions
> of config variables as it doesn't have any impact on it's usage.

nit: s/it's/its/ (in both places)

> Signed-off-by: Kaartic Sivaraam <kaarticsivaraam91196@gmail•com>
> ---
>  Documentation/git-branch.txt | 4 ++--
>  Documentation/git-tag.txt    | 2 +-
>  2 files changed, 3 insertions(+), 3 deletions(-)

This also is just more consistent with the rest of the docs.

FWIW, with or without the commit message tweaks mentioned above,
Reviewed-by: Jonathan Nieder <jrnieder@gmail•com>

Thanks for your attention to detail.

next prev parent reply	other threads:[~2017-09-19 20:22 UTC|newest]

Thread overview: 7+ 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 [this message]
2017-09-20  8:03   ` Kaartic Sivaraam
2017-09-23  4:56   ` [PATCH v2] " Kaartic Sivaraam
2017-09-24  0:28     ` Junio C Hamano
2017-09-24  5:21       ` Kaartic Sivaraam
2017-09-25  8:27       ` [PATCH v3] " 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

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

  git send-email \
    --in-reply-to=20170919202201.GD75068@aiede.mtv.corp.google.com \
    --to=jrnieder@gmail$(echo .)com \
    --cc=git@vger$(echo .)kernel.org \
    --cc=kaarticsivaraam91196@gmail$(echo .)com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox