Thread: Beautify pg_walinspect docs a bit

Hi,

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?

[1] https://www.postgresql.org/message-id/Y7+gQy/lOuWk4tFj@paquier.xyz

-- 
Bharath Rupireddy
PostgreSQL Contributors Team
RDS Open Source Databases
Amazon Web Services: https://aws.amazon.com

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

It looks like 58597ed accidentally added an "end_lsn" to the docs for
pg_get_wal_stats_till_end_of_wal().

diff --git a/doc/src/sgml/pgwalinspect.sgml b/doc/src/sgml/pgwalinspect.sgml
index 22677e54f2..3d7cdb95cc 100644
--- a/doc/src/sgml/pgwalinspect.sgml
+++ b/doc/src/sgml/pgwalinspect.sgml
@@ -174,7 +174,7 @@ combined_size_percentage     | 2.8634072910530795
     <varlistentry id="pgwalinspect-funcs-pg-get-wal-stats-till-end-of-wal">
     <term>
      <function>
-      pg_get_wal_stats_till_end_of_wal(start_lsn pg_lsn, end_lsn pg_lsn, per_record boolean DEFAULT false)
+      pg_get_wal_stats_till_end_of_wal(start_lsn pg_lsn, per_record boolean DEFAULT false)
       returns setof record
      </function>
     </term>

-- 
Nathan Bossart
Amazon Web Services: https://aws.amazon.com

On Tue, Feb 28, 2023 at 11:57:40AM -0800, Nathan Bossart wrote:
> It looks like 58597ed accidentally added an "end_lsn" to the docs for
> pg_get_wal_stats_till_end_of_wal().

Indeed.  Fixed, thanks!
--
Michael