Re: Typo.

From: Dmitry Igrishin <dmitigr(at)gmail(dot)com>
To: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Cc: Kevin Grittner <kgrittn(at)gmail(dot)com>, pgsql-docs <pgsql-docs(at)postgresql(dot)org>
Subject: Re: Typo.
Date: 2016-06-07 14:20:33
Message-ID: CAAfz9KP12cpVUnRXojQE31cr9SbyDKva++WWspcr-MHS2s5vBg@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

2016-06-07 16:47 GMT+03:00 Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>:
> Dmitry Igrishin <dmitigr(at)gmail(dot)com> writes:
>> 2016-06-07 15:44 GMT+03:00 Kevin Grittner <kgrittn(at)gmail(dot)com>:
>>> I'm pretty sure that this has been discussed on this list before
>>> and decided in favor of omitting the hyphenation in such cases.
>
>> Hm, well, how about removing hypenation from
>> "Internal query: the text of a failed internally-generated command",
>> "procedural language functions and internally-generated queries",
>> at https://www.postgresql.org/docs/9.6/static/protocol-error-fields.html
>> and similar in other places?
>
> They are both correct: it's just a matter of preference which one is used
> in a particular place. Any particular instance might be that way because
> whoever wrote it always writes that way, or maybe they actually thought
> about it and decided a hyphen did or didn't read better there.
Hm, maybe. Shrug.

> (To my taste, a hyphen is better if the phrase is being used as a compound
> adjective, and otherwise probably not; but it's a minor thing.)
Yes, I agree here.

> It's just make-work to try to make all the many hundreds of places where we have
> such wording 100% consistent; and I seriously doubt that it would create
> any improvement in readability.
>
> If you're looking to improve the docs, there are many places where the
> English is actually pretty bad ... but this isn't one.
Well, I usually report here when I read the documentation to do my
work and see some annoying inconsistency. And often I stop myself, but
in certain cases I can't refrain not to report. Sorry if I too bother
for things that don't worth it.

--
// Dmitry.

In response to

  • Re: Typo. at 2016-06-07 13:47:18 from Tom Lane

Browse pgsql-docs by date

  From Date Subject
Next Message Simon Riggs 2016-06-07 14:46:17 Copy editing of Dynamic Shared Memory code comments
Previous Message Tom Lane 2016-06-07 13:47:18 Re: Typo.