Re: tiny documentation fix

From: Daniel Gustafsson <daniel(at)yesql(dot)se>
To: Michael Paquier <michael(at)paquier(dot)xyz>
Cc: Amit Langote <amitlangote09(at)gmail(dot)com>, PostgreSQL-development <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: tiny documentation fix
Date: 2020-02-17 12:06:21
Message-ID: 7A1FAD55-B9ED-4962-AAF3-83F03B2474C0@yesql.se
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

> On 17 Feb 2020, at 10:42, Michael Paquier <michael(at)paquier(dot)xyz> wrote:
>
> On Mon, Feb 17, 2020 at 03:55:46PM +0900, Amit Langote wrote:
>> I propose this small fix for 27.4. Progress Reporting:
>>
>> - all of its partitions are also recursively analyzed as also mentioned on
>> + all of its partitions are also recursively analyzed as also mentioned in
>> <xref linkend="sql-analyze"/>.
>>
>> Note the last word: "in" sounds more correct.
>
> What you are suggesting sounds much better to me than the original.
> Do others have comments or objections?

In my understanding, the difference comes from how the link is interpreted, is
the mention "on a webpage" or "in a section". Personally I prefer 'in' as it
works for the PDF docs as well as the web docs. In doc/src/sgml/mvcc.sgml
there is similar instance where we've used "in <xref ..":

"As mentioned in <xref linkend="xact-serializable"/>, Serializable
transactions are just Repeatable Read transactions which add"

Changing as per the patch makes these consistent, so +1 on doing that.

cheers ./daniel

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Fujii Masao 2020-02-17 13:00:15 Re: pg_stat_progress_basebackup - progress reporting for pg_basebackup, in the server side
Previous Message Julien Rouhaud 2020-02-17 11:55:12 Re: tiny documentation fix