From: Tom Lane <tgl@sss.pgh.pa.us>
To: "David G. Johnston" <david.g.johnston@gmail.com>
cc: Robert Inder <robert@interactive.co.uk>,
        Pg Docs <pgsql-docs@lists.postgresql.org>
Subject: Re: PostgreSQL 12: Cryptic documentation
In-reply-to: 
 <CAKFQuwaM_2ocg33k6esUA6_4dZEkmaEPubQc=QGFpNR3VmmN=w@mail.gmail.com>
References: <159749418850.14322.216503677134569752@wrigleys.postgresql.org>
 <CAKFQuwaM_2ocg33k6esUA6_4dZEkmaEPubQc=QGFpNR3VmmN=w@mail.gmail.com>
Comments: In-reply-to "David G. Johnston" <david.g.johnston@gmail.com>
	message dated "Sat, 15 Aug 2020 09:21:54 -0700"
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-ID: <904675.1597509527.1@sss.pgh.pa.us>
Date: Sat, 15 Aug 2020 12:38:47 -0400
Message-ID: <904676.1597509527@sss.pgh.pa.us>
Precedence: bulk

"David G. Johnston" <david.g.johnston@gmail.com> writes:
> As with most things there is always room for improvement.  In this case,
> though, I'm not seeing anything wrong with the direct wording provided.

Also, it's under a heading that says "The following command-line options
control the location and format of the output", which ought to make it
clear that it's not about the source server's WAL dir.  (Although I notice
that whoever added the --max-rate parameter didn't read that heading :-()

Still, I see that the main -D parameter is described as "Directory to
write the output to", which seems like a clearer phrasing, so I'm inclined
to similarly reword the description of --waldir.

A more direct criticism of the --waldir description is that it's not
stated what happens if you don't provide that argument.

I notice some shaky grammar and other minor annoyances in this page,
so I'm kind of inclined to make an editorial pass over the whole thing.

			regards, tom lane