Re: small fix for pg_overexplain docs

From: Dean Rasheed <dean(dot)a(dot)rasheed(at)gmail(dot)com>
To: Robert Treat <rob(at)xzilla(dot)net>
Cc: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>, Nathan Bossart <nathandbossart(at)gmail(dot)com>, pgsql-hackers(at)postgresql(dot)org
Subject: Re: small fix for pg_overexplain docs
Date: 2025-07-15 15:14:44
Message-ID: CAEZATCUEaasoxNPSva5mOWJ-Lu92U6ryprB2Dgdt-_9DEdCoRw@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

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.

Something else that's missing is instructions on how to load the
module, which usually follows this first paragraph.

Regards,
Dean

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Fujii Masao 2025-07-15 15:20:05 Re: Logical replication launcher did not automatically restart when got SIGKILL
Previous Message Tom Lane 2025-07-15 15:11:26 Re: remove WITHOUT OIDS syntax for v19