Date: Thu, 4 Mar 2021 10:29:12 -0600
From: Justin Pryzby <pryzby@telsasoft.com>
To: Matthias van de Meent <boekewurm+postgres@gmail.com>
Cc: Bharath Rupireddy <bharath.rupireddyforpostgres@gmail.com>,
	Michael Paquier <michael@paquier.xyz>,
	Tomas Vondra <tomas.vondra@enterprisedb.com>,
	Josef =?utf-8?B?xaBpbcOhbmVr?= <josef.simanek@gmail.com>,
	pgsql-hackers@postgresql.org
Subject: Re: Improvements and additions to COPY progress reporting
Message-ID: <20210304162912.GO29832@telsasoft.com>
References: 
 <CALj2ACXQrFM+DSN9xr=+yRotBufnC_xgG-FQ6VXAUZRPihZAew@mail.gmail.com>
 <YDGZ1jnuwdjEn+4P@paquier.xyz>
 <CAEze2Wjd9JQS_LjLS+cSsuF0Z28Xg4DG9cKi-XBAAjWxCtf_nA@mail.gmail.com>
 <20210224075303.GI14772@telsasoft.com>
 <YDdcayzvkIDm2mwI@paquier.xyz>
 <CALj2ACUK_pJbwcamMaHm4hqKch++Ca35PtpHzeOAWFaCc5up7A@mail.gmail.com>
 <YEC4kHMGaJIR6PZB@paquier.xyz>
 <CAEze2WhQL_HBemwPA-D=icCsR7e+W0yKihwP_CoexSh=kGT8yg@mail.gmail.com>
 <CALj2ACXDX0oY46XNrQoBvGRyEANZnhSew3SB92RL0n5x5bAREw@mail.gmail.com>
 <CAEze2WiT=nZYmegVmK=MK6yOxf-h+zV7S-9C0soLdiKX_-WQtg@mail.gmail.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: 
 <CAEze2WiT=nZYmegVmK=MK6yOxf-h+zV7S-9C0soLdiKX_-WQtg@mail.gmail.com>
User-Agent: Mutt/1.9.4 (2018-02-28)
Archived-At: 
 <https://www.postgresql.org/message-id/20210304162912.GO29832%40telsasoft.com>
Precedence: bulk

On Thu, Mar 04, 2021 at 05:19:18PM +0100, Matthias van de Meent wrote:
> On Thu, 4 Mar 2021 at 13:36, Bharath Rupireddy <bharath.rupireddyforpostgres@gmail.com> wrote:
> >
> > +   <para>
> > +    Each backend running <command>VACUUM</command> without the
> > +    <literal>FULL</literal> option will report its progress in the
> > +    <structname>pg_stat_progress_vacuum</structname> view. Backends running
> > +    <command>VACUUM</command> with the <literal>FULL</literal> option report
> > +    progress in the <structname>pg_stat_progress_cluster</structname> view
> > +    instead. See <xref linkend="vacuum-progress-reporting"/> and
> > +    <xref linkend="cluster-progress-reporting"/> for details.
> > +   </para>
> >
> > I think a typo, missing "will" between option and report - it's "with
> > the <literal>FULL</literal> option will report"
> 
> "Backends running [...] report progress to [...] instead" is,
> a.f.a.i.k., correct English. Adding 'will' would indeed still be
> correct, but it would in my opinion also be decremental to the
> readability of the section due to the repeated use of the same
> template sentence structure. I think that keeping it as-is is just
> fine.

I'd prefer to see the same thing repeated, since then it's easy to compare, for
readers, and also future doc authors.  That's normal in technical documentation
to have redundancy.  It's easy to read.

I'd suggest to move "instead" into the middle of the sentence,
and combine VACUUM+FULL, and add "their":

> > +    ... Backends running <command>VACUUM FULL</literal> will instead report
> > +    their progress in the <structname>pg_stat_progress_cluster</structname> view.

-- 
Justin