Re: --sync-method isn't documented to take an argument - Mailing list pgsql-hackers

From Daniel Gustafsson
Subject Re: --sync-method isn't documented to take an argument
Date
Msg-id 6F6913AC-C67D-448B-AB80-9AFA4B431245@yesql.se
Whole thread Raw
In response to Re: --sync-method isn't documented to take an argument  (Robert Haas <robertmhaas@gmail.com>)
Responses Re: --sync-method isn't documented to take an argument
List pgsql-hackers
> On 4 Oct 2023, at 15:22, Robert Haas <robertmhaas@gmail.com> wrote:
>
> On Wed, Oct 4, 2023 at 9:15 AM Daniel Gustafsson <daniel@yesql.se> wrote:
>>> On 4 Oct 2023, at 15:08, Robert Haas <robertmhaas@gmail.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




pgsql-hackers by date:

Previous
From: Ashutosh Bapat
Date:
Subject: Re: Infinite Interval
Next
From: James Coleman
Date:
Subject: Re: [DOCS] HOT - correct claim about indexes not referencing old line pointers