Downloads
Home   >   mailing lists

Re: small fix for pg_overexplain docs - Mailing list pgsql-hackers

From David G. Johnston
Subject Re: small fix for pg_overexplain docs
Date
Msg-id CAKFQuwZx9XjKhmgJeJa=6p3XePWadETJtMauhr+2XY8Nkb8OcA@mail.gmail.com
Whole thread Raw
In response to small fix for pg_overexplain docs  (Nathan Bossart <nathandbossart@gmail.com>)
Responses Re: small fix for pg_overexplain docs
List pgsql-hackers
Tree view
On Mon, Jul 14, 2025 at 12:10 PM Nathan Bossart <nathandbossart@gmail.com> wrote:
I noticed that pg_overexplain's documentation leads off with this sentence:

        The pg_overexplain extends EXPLAIN with...

Presumably that's meant to be something like:

        The pg_overexplain MODULE extends EXPLAIN with...

Another pattern in adjacent pages is to leave out the "The":

        pg_overexplain extends EXPLAIN with...

The attached patch removes the "The".  If there are no objections, I will
commit this shortly.


Randomly picking 3 other modules turns up:

The pgrowlocks module provides...
The pgcrypto module provides cryptographic...
This module implements the hstore data type for storing sets...
The pg_logicalinspect module provides SQL...

A leading "The" and using the word "module" seems to be a more consistent choice.

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)

David J.

pgsql-hackers by date:

Previous
From: Nathan Bossart
Date:
Subject: Re: small fix for pg_overexplain docs
Next
From: Sami Imseih
Date:
Subject: Re: Improve LWLock tranche name visibility across backends