Re: Beautify pg_walinspect docs a bit - Mailing list pgsql-hackers

From Michael Paquier
Subject Re: Beautify pg_walinspect docs a bit
Date
Msg-id Y8CmykCJ/C23wxFR@paquier.xyz
Whole thread Raw
In response to Beautify pg_walinspect docs a bit  (Bharath Rupireddy <bharath.rupireddyforpostgres@gmail.com>)
Responses Re: Beautify pg_walinspect docs a bit
List pgsql-hackers
On Thu, Jan 12, 2023 at 05:29:39PM +0530, Bharath Rupireddy wrote:
> As discussed [1], here's a patch to beautify pg_walinspect docs
> similar to pageinspect docs. The existing pg_walinspect docs calls out
> the column names explicitly and then also shows them in the function
> execution examples which is duplicate and too informative. Also \x
> isn't used so some of the execution outputs are out of indentation.
>
> Thoughts?

Thanks, this looked basically fine, so applied.  I have tweaked a few
sentences while reviewing the docs, while on it.  I have decided to
remove the example where we specify per_record=true for
pg_get_wal_stats(), as it does not bring much value while bloating the
whole, and the parameter is clearly documented.
--
Michael

Attachment

pgsql-hackers by date:

Previous
From: Nathan Bossart
Date:
Subject: Re: document the need to analyze partitioned tables
Next
From: vignesh C
Date:
Subject: Re: mprove tab completion for ALTER EXTENSION ADD/DROP