Re: Beautify pg_walinspect docs a bit

From: Michael Paquier <michael(at)paquier(dot)xyz>
To: Bharath Rupireddy <bharath(dot)rupireddyforpostgres(at)gmail(dot)com>
Cc: PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Beautify pg_walinspect docs a bit
Date: 2023-01-13 00:33:14
Message-ID: Y8CmykCJ/C23wxFR@paquier.xyz
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: 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

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message vignesh C 2023-01-13 00:47:59 Re: mprove tab completion for ALTER EXTENSION ADD/DROP
Previous Message Nathan Bossart 2023-01-12 23:27:47 Re: document the need to analyze partitioned tables