git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Marc Branchaud <marcnarc@xiplink.com>,
	git@vger.kernel.org, Fredrik Gustafsson <iveqy@iveqy.com>
Subject: Re: [PATCH v2] Provide some linguistic guidance for the documentation.
Date: Thu, 1 Aug 2013 23:25:41 -0700	[thread overview]
Message-ID: <20130802062511.GA3013@elie.Belkin> (raw)
In-Reply-To: <7vfvuts25p.fsf@alter.siamese.dyndns.org>

Junio C Hamano wrote:

> Is that accurate?  My impression has been:
>
>     The documentation liberally mixes US and UK English (en_US/UK)
>     norms for spelling and grammar, which is somewhat unfortunate.
>     In an ideal world, it would have been better if it consistently
>     used only one and not the other, and we would have picked en_US.

I'm not convinced that would be better, even in an ideal world.

It's certainly useful to have a consistent spelling of each term to
make searching with "grep" easier.  But searches with "grep" do not
work well with line breaks anyway, and search engines for larger
collections of documents seem to know about the usual spelling
variants (along with knowing about stemming, etc).  Unless we are
planning to provide a separate en_GB translation, it seems unfortunate
to consistently have everything spelled in the natural way for one
group of people and in an unnatural way for another, just in the name
of having a convention.

I am not sure it makes sense for the documentation to say "A huge
disruptive patch of such-and-such specific kind of no immediate
benefit is unwelcome".  Isn't there some more general principle that
implies that?  Or the CodingGuidelines could simply say

	The documentation uses a mixture of U.S. and British English.

My two cents,
Jonathan

  parent reply	other threads:[~2013-08-02  6:25 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-07-29 21:15 [PATCH] Documentation: fix typos in man pages Øystein Walle
2013-07-30 14:51 ` Marc Branchaud
2013-07-30 15:05   ` Junio C Hamano
2013-07-30 15:11   ` [PATCH] Specify UK English for the documentation source files Marc Branchaud
2013-07-30 15:52     ` Fredrik Gustafsson
2013-07-30 16:40     ` Junio C Hamano
2013-08-01 15:10     ` [PATCH v2] Provide some linguistic guidance for the documentation Marc Branchaud
2013-08-01 15:14       ` Marc Branchaud
2013-08-01 18:21       ` Junio C Hamano
2013-08-01 18:49         ` [PATCH v3] " Marc Branchaud
2013-08-02  6:25         ` Jonathan Nieder [this message]
2013-08-02 14:16           ` [PATCH v2] " Marc Branchaud

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=20130802062511.GA3013@elie.Belkin \
    --to=jrnieder@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=iveqy@iveqy.com \
    --cc=marcnarc@xiplink.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).