Re: small fix for pg_overexplain docs

From: Robert Treat <rob(at)xzilla(dot)net>
To: Nathan Bossart <nathandbossart(at)gmail(dot)com>
Cc: Dean Rasheed <dean(dot)a(dot)rasheed(at)gmail(dot)com>, "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>, pgsql-hackers(at)postgresql(dot)org
Subject: Re: small fix for pg_overexplain docs
Date: 2025-07-17 18:58:20
Message-ID: CAJSLCQ19rWgg3GajZxNzKMLvCXFU3PXCUv-4qpWi=9F3DqqMMw@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Wed, Jul 16, 2025 at 1:26 PM Nathan Bossart <nathandbossart(at)gmail(dot)com> wrote:
>
> On Tue, Jul 15, 2025 at 04:14:44PM +0100, Dean Rasheed wrote:
> > On Tue, 15 Jul 2025 at 04:17, Robert Treat <rob(at)xzilla(dot)net> wrote:
> >> On Mon, Jul 14, 2025 at 3:22 PM David G. Johnston
> >> > The pg_overexplain extends EXPLAIN with new options that provide...
> >> > Suggest instead:
> >> > The pg_overexplain module provides EXPLAIN with new options intended to assist with debugging of and development of the planner.
> >> > (replacing the first two sentences of the existing paragraph)
> >>
> >> +1 for consistency, though I'd argue "intended to assist with
> >> debugging and development of the planner" would be easier to read (in
> >> either one sentence or two sentence format).
> >
> > +1. I find that easier to read.
>
> I disagree. While it might sound nicer, the extra "of" establishes
> parallelism to make it clear that the module is intended for debugging of
> the planner and not debugging in general.

Grammatically speaking, the "and" establishes parallelism in the
sentence, not the extra "of", which is superfluous (and imho is what
subconsciously causes the existing text to feel more awkward). Of
course, you could also flip it to say "... to assist with planner
debugging and development".

*shrug*

Robert Treat
https://xzilla.net

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Jeff Davis 2025-07-17 18:59:14 Re: Collation and primary keys
Previous Message Masahiko Sawada 2025-07-17 18:55:54 Re: POC: enable logical decoding when wal_level = 'replica' without a server restart