Horton

Re: small fix for pg_overexplain docs

Dean Rasheed <dean.a.rasheed@gmail.com>

View thread View on postgr.es
From: Dean Rasheed <dean.a.rasheed@gmail.com>
To: Robert Treat <rob@xzilla.net>
Cc: "David G. Johnston" <david.g.johnston@gmail.com>, Nathan Bossart <nathandbossart@gmail.com>, pgsql-hackers@postgresql.org
Date: 2025-07-15T15:14:44Z
Lists: pgsql-hackers 
On Tue, 15 Jul 2025 at 04:17, Robert Treat <rob@xzilla.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

Commits

  1. doc: Add note about how to use pg_overexplain.