Re: Beautify pg_walinspect docs a bit
Michael Paquier <michael@paquier.xyz>
From: Michael Paquier <michael@paquier.xyz>
To: Bharath Rupireddy <bharath.rupireddyforpostgres@gmail.com>
Cc: PostgreSQL Hackers <pgsql-hackers@lists.postgresql.org>
Date: 2023-01-13T00:33:14Z
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
Commits
-
doc: Fix description of pg_get_wal_stats_till_end_of_wal() in pg_walinspect
- b5784e6a5ecd 15.3 landed
- 019f8624664d 16.0 landed
-
doc: Simplify description of functions for pg_walinspect
- 93595ffd5964 15.2 landed
- 58597edea102 16.0 landed