Remove 'IN' from pg_freespace docs for consistency

Started by Bharath Rupireddyalmost 4 years ago1 messages

bharath.rupireddyforpostgres@gmail.com

almost 4 years ago

1 attachment(s)

Hi,

It seems like 'IN' isn't used for description of a function input
parameter in the docs unlike 'OUT'. AFAICS this is consistent across
the docs except the function pg_freespace. Attaching a tiny patch to
remove 'IN' there.

Thoughts?

Regards,
Bharath Rupireddy.

Attachments:

v1-0001-Remove-IN-from-pg_freespace-docs-for-consistency.patchapplication/octet-stream; name=v1-0001-Remove-IN-from-pg_freespace-docs-for-consistency.patchDownload

From f36d4d6adefd39b651260323eb0c2814dd74a59b Mon Sep 17 00:00:00 2001
From: Bharath Rupireddy <bharath.rupireddyforpostgres@gmail.com>
Date: Thu, 10 Feb 2022 11:24:40 +0000
Subject: [PATCH v1] Remove 'IN' from pg_freespace docs for consistency

---
 doc/src/sgml/pgfreespacemap.sgml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/src/sgml/pgfreespacemap.sgml b/doc/src/sgml/pgfreespacemap.sgml
index 5025498249..0908bfb53d 100644
--- a/doc/src/sgml/pgfreespacemap.sgml
+++ b/doc/src/sgml/pgfreespacemap.sgml
@@ -27,7 +27,7 @@
   <variablelist>
    <varlistentry>
     <term>
-     <function>pg_freespace(rel regclass IN, blkno bigint IN) returns int2</function>
+     <function>pg_freespace(rel regclass, blkno bigint) returns int2</function>
      <indexterm>
       <primary>pg_freespace</primary>
      </indexterm>
@@ -44,7 +44,7 @@
 
    <varlistentry>
     <term>
-     <function>pg_freespace(rel regclass IN, blkno OUT bigint, avail OUT int2)</function>
+     <function>pg_freespace(rel regclass, blkno OUT bigint, avail OUT int2)</function>
     </term>
 
     <listitem>
-- 
2.25.1