public inbox for [email protected]  

help / color / mirror / Atom feed

From: Daniel Gustafsson <[email protected]>
To: Robert Haas <[email protected]>
Cc: PostgreSQL Hackers <[email protected]>
Cc: Nathan Bossart <[email protected]>
Subject: Re: --sync-method isn't documented to take an argument
Date: Wed, 4 Oct 2023 15:34:49 +0200
Message-ID: <[email protected]> (raw)
In-Reply-To: <CA+TgmobiftxwkdnLByjX5muZv_8xZ-P5kAsdNCGAKYUFMGW3uw@mail.gmail.com>
References: <CA+TgmoZi7pcx-ec3oJLWSr2R=Dn2Zeiyx3EXQKc_1TTvA6Eepg@mail.gmail.com>
	<[email protected]>
	<CA+TgmobiftxwkdnLByjX5muZv_8xZ-P5kAsdNCGAKYUFMGW3uw@mail.gmail.com>

> On 4 Oct 2023, at 15:22, Robert Haas <[email protected]> wrote:
> 
> On Wed, Oct 4, 2023 at 9:15 AM Daniel Gustafsson <[email protected]> wrote:
>>> On 4 Oct 2023, at 15:08, Robert Haas <[email protected]> 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

view thread (5+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected], [email protected]
  Subject: Re: --sync-method isn't documented to take an argument
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox