I noticed today that the signature for two functions is wrong
in the documentation:

- "heap_page_item_attrs" has the argument order and return type wrong
  and is lacking types

- "tuple_data_split" is lacking the type for "rel_oid"

Patch attached.

This should be backpatched down to 9.6 where the functions have been added.

Yours,
Laurenz Albe
From 4e9655a24a8f86b020c50431eba2376f624a3def Mon Sep 17 00:00:00 2001
From: Laurenz Albe <laurenz.a...@cybertec.at>
Date: Thu, 7 Mar 2019 20:50:05 +0100
Subject: [PATCH] Fix documentation of pageinspect function signatures

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

diff --git a/doc/src/sgml/pageinspect.sgml b/doc/src/sgml/pageinspect.sgml
index 9cbe34c9d9..eac67352ec 100644
--- a/doc/src/sgml/pageinspect.sgml
+++ b/doc/src/sgml/pageinspect.sgml
@@ -156,7 +156,7 @@ test=# SELECT * FROM heap_page_items(get_raw_page('pg_class', 0));
 
    <varlistentry>
     <term>
-     <function>tuple_data_split(rel_oid, t_data bytea, t_infomask integer, t_infomask2 integer, t_bits text [, do_detoast bool]) returns bytea[]</function>
+     <function>tuple_data_split(rel_oid oid, t_data bytea, t_infomask integer, t_infomask2 integer, t_bits text [, do_detoast bool]) returns bytea[]</function>
      <indexterm>
       <primary>tuple_data_split</primary>
      </indexterm>
@@ -181,7 +181,7 @@ test=# SELECT tuple_data_split('pg_class'::regclass, t_data, t_infomask, t_infom
 
    <varlistentry>
     <term>
-     <function>heap_page_item_attrs(rel_oid, t_data bytea, [, do_detoast bool]) returns bytea[]</function>
+     <function>heap_page_item_attrs(t_data bytea, rel_oid regclass, [, do_detoast bool]) returns setof record</function>
      <indexterm>
       <primary>heap_page_item_attrs</primary>
      </indexterm>
-- 
2.20.1

Reply via email to