public inbox for [email protected]  

help / color / mirror / Atom feed

From: Kevin Grittner <[email protected]>
To: Marti Raudsepp <[email protected]>
Cc: pgsql-docs <[email protected]>
Subject: Re: [PATCH] Various documentation typo/grammar fixes
Date: Sat, 30 Aug 2014 09:33:03 -0700
Message-ID: <[email protected]> (raw)
In-Reply-To: <CABRT9RCR8XziafHjS=P6DvKxQ2x1T=EnmB4MsLBqwf23byDOig@mail.gmail.com>
References: <CABRT9RA_kHEZrw9W=C_yYpR8+TTLqVMVKUSU0hrLC213cJ4Hyg@mail.gmail.com>
	<[email protected]>
	<CABRT9RBDUVXJGoVP3CGL2y5JbpqHSGjH1871wPBj3fw+qX_b3g@mail.gmail.com>
	<[email protected]>
	<CABRT9RCR8XziafHjS=P6DvKxQ2x1T=EnmB4MsLBqwf23byDOig@mail.gmail.com>
List-Unsubscribe: <mailto:[email protected]?body=unsub%20pgsql-docs>

Marti Raudsepp <[email protected]> wrote:

> All updated patches attached, per our previous discussion.
> Patches 1-2 are ready, 3 can be discarded unless someone else
> chimes in.

Patch 1 pushed, with each fix back-patched as far as the error
exists in supported releases.  I held off on patch 2 -- partly
because I spotted at least one case where things weren't quite
right, partly because there's so much I haven't had time to go over
it in sufficient detail, and partly because commas are omitted so
consistently where most style guides want them that I thought
someone might want to argue that this was an intentional style
choice and should be preserved.  I'm also not sure that it should
be back-patched as the outright errors were -- it does seem like
more of a style issue than most of the things in patch 1 were,
which included clear misspellings, accidentally repeated words, and
incorrect choices of indefinite articles.

The remaining error I mentioned above was an occurrence of a
parenthetical remark which started with "e.g.," and ended with
", etc.").  The Chicago Manual of Style says that you can use one
or the other, but using both is redundant and should be avoided.

> Do you think it's worth doing a run over developer documentation
> (README files) and code comments too, or is that a waste of time?

Some README files could use a lot of attention; I'm just not sure
that fixing a few misspelling, repeated words, or grammar errors
makes enough of a dent in what is needed to be worth it.

--
Kevin Grittner
EDB: http://www.enterprisedb.com
The Enterprise PostgreSQL Company


-- 
Sent via pgsql-docs mailing list ([email protected])
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs

view thread (14+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected]
  Subject: Re: [PATCH] Various documentation typo/grammar fixes
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox