Thread: [doc] minor wording improvement in a couple of places

[doc] minor wording improvement in a couple of places

From
Ian Barwick
Date:
Hi

On these pages:

   https://www.postgresql.org/docs/current/fdw-callbacks.html
   https://www.postgresql.org/docs/current/tablesample-method.html

we have the phrase:

   "..., which see for additional details."

which strikes me as a bit odd. Suggested phrasing:

   "...; see this file for additional details."

Regards

Ian Barwick

-- 
Ian Barwick                   https://www.2ndQuadrant.com/
  PostgreSQL Development, 24x7 Support, Training & Services

Attachment

Re: [doc] minor wording improvement in a couple of places

From
Magnus Hagander
Date:
On Mon, Sep 7, 2020 at 6:34 AM Ian Barwick <ian.barwick@2ndquadrant.com> wrote:
Hi

On these pages:

   https://www.postgresql.org/docs/current/fdw-callbacks.html
   https://www.postgresql.org/docs/current/tablesample-method.html

we have the phrase:

   "..., which see for additional details."

which strikes me as a bit odd. Suggested phrasing:

   "...; see this file for additional details."


I agree this sounds very weird. However, this phrasing is also fairly common in comments around the code.

I was first guessing that this came out of one of us non-english native speakers, but AFAICT it's a mix of authors and definitely including those natively speaking the language. 

I would still suggest that we change it, because it does sound odd to me as well, but I'll defer a bit and see if others might think we should keep it. 


--

Re: [doc] minor wording improvement in a couple of places

From
John Naylor
Date:
On Mon, Sep 7, 2020 at 6:30 AM Magnus Hagander <magnus@hagander.net> wrote:
>
> On Mon, Sep 7, 2020 at 6:34 AM Ian Barwick <ian.barwick@2ndquadrant.com> wrote:
>>    "..., which see for additional details."
>>
>> which strikes me as a bit odd. Suggested phrasing:
>>
>>    "...; see this file for additional details."
>>
>
> I agree this sounds very weird. However, this phrasing is also fairly common in comments around the code.

Seems to be a literal translation of Latin "quod vide" (q.v.), so
intentional, just sounds a bit old fashioned. I'd vote to keep it.

-- 
John Naylor                https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services