Re: small fix for pg_overexplain docs

On Mon, Jul 14, 2025 at 12:10 PM Nathan Bossart <nathandbossart(at)gmail(dot)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.