Re: --sync-method isn't documented to take an argument

From: Daniel Gustafsson <daniel(at)yesql(dot)se>
To: Robert Haas <robertmhaas(at)gmail(dot)com>
Cc: PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org>, Nathan Bossart <nathandbossart(at)gmail(dot)com>
Subject: Re: --sync-method isn't documented to take an argument
Date: 2023-10-04 13:34:49
Message-ID: 6F6913AC-C67D-448B-AB80-9AFA4B431245@yesql.se
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

> On 4 Oct 2023, at 15:22, Robert Haas <robertmhaas(at)gmail(dot)com> wrote:
>
> On Wed, Oct 4, 2023 at 9:15 AM Daniel Gustafsson <daniel(at)yesql(dot)se> wrote:
>>> On 4 Oct 2023, at 15:08, Robert Haas <robertmhaas(at)gmail(dot)com> wrote:
>>> This one should be something like this:
>>>
>>> <term><option>--sync-method=<replaceable>method</replaceable></option></term>
>>
>> Shouldn't it be <replaceable class="parameter">method</replaceable> ?
>
> Hmm, I think you're probably right. But look at this:
>
> <term><option>-S <replaceable>slotname</replaceable></option></term>
> <term><option>--slot=<replaceable
> class="parameter">slotname</replaceable></option></term>
>
> But then in the very same file:
>
> <term><option>-r <replaceable
> class="parameter">rate</replaceable></option></term>
> <term><option>--max-rate=<replaceable
> class="parameter">rate</replaceable></option></term>

Hmm.. that's a bit unfortunate.

> It doesn't look to me like we're entirely consistent about this.

That (sadly) applies to a fair chunk of the docs.

I can take a stab at tidying this up during breaks at the conference. It might
not be the most important bit of markup, but for anyone building the docs who
might want to use this it seems consistency will help.

--
Daniel Gustafsson

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message James Coleman 2023-10-04 13:35:55 Re: [DOCS] HOT - correct claim about indexes not referencing old line pointers
Previous Message Ashutosh Bapat 2023-10-04 13:29:16 Re: Infinite Interval