Doc: fix parameter names in the docs of a couple of functions.
authorTom Lane <[email protected]>
Mon, 5 Oct 2020 15:42:33 +0000 (11:42 -0400)
committerTom Lane <[email protected]>
Mon, 5 Oct 2020 15:42:33 +0000 (11:42 -0400)
The descriptions of make_interval() and pg_options_to_table()
were randomly different from the reality embedded in pg_proc.

(These are not all the discrepancies I found in a quick search,
but the others perhaps require more discussion, since there's
at least a case to be made for changing pg_proc not the docs.)

make_interval issue noted by Thomas Kellerer.

Discussion: https://postgr.es/m/7b154ef0-9f22-90b9-7734-4bf23686695b@gmx.net

doc/src/sgml/func.sgml

index ec8451d1b9b9d2fac2b4e55d1f27a841de4148df..e7cff980ddf9d088822cf555a8e051217187ea22 100644 (file)
@@ -8960,13 +8960,13 @@ SELECT regexp_match('abc01234xyz', '(?:(.*?)(\d+)(.*)){1,1}');
         <entry role="func_table_entry"><para role="func_signature"><indexterm>
           <primary>make_interval</primary>
          </indexterm>
-         <function>make_interval</function> ( <optional> <parameter>year</parameter> <type>int</type>
-         <optional>, <parameter>month</parameter> <type>int</type>
-         <optional>, <parameter>week</parameter> <type>int</type>
-         <optional>, <parameter>day</parameter> <type>int</type>
-         <optional>, <parameter>hour</parameter> <type>int</type>
-         <optional>, <parameter>min</parameter> <type>int</type>
-         <optional>, <parameter>sec</parameter> <type>double precision</type>
+         <function>make_interval</function> ( <optional> <parameter>years</parameter> <type>int</type>
+         <optional>, <parameter>months</parameter> <type>int</type>
+         <optional>, <parameter>weeks</parameter> <type>int</type>
+         <optional>, <parameter>days</parameter> <type>int</type>
+         <optional>, <parameter>hours</parameter> <type>int</type>
+         <optional>, <parameter>mins</parameter> <type>int</type>
+         <optional>, <parameter>secs</parameter> <type>double precision</type>
          </optional></optional></optional></optional></optional></optional></optional> )
          <returnvalue>interval</returnvalue>
         </para>
@@ -22416,7 +22416,7 @@ SELECT currval(pg_get_serial_sequence('sometable', 'id'));
         <indexterm>
          <primary>pg_options_to_table</primary>
         </indexterm>
-        <function>pg_options_to_table</function> ( <parameter>reloptions</parameter> <type>text[]</type> )
+        <function>pg_options_to_table</function> ( <parameter>options_array</parameter> <type>text[]</type> )
         <returnvalue>setof record</returnvalue>
         ( <parameter>option_name</parameter> <type>text</type>,
         <parameter>option_value</parameter> <type>text</type> )