Missing parentheses

Started by Marcos Pegoraro4 months ago8 messages
#1Marcos Pegoraro
marcos@f10.com.br
1 attachment(s)

New function uuidv7 was added and that changed how other two functions are
described on DOCs, so is missing parentheses on both.

regards
Marcos

Attachments:

patch.diffapplication/octet-stream; name=patch.diffDownload
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 8a347bec62c..d99576d8159 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -14437,11 +14437,11 @@ CREATE TYPE rainbow AS ENUM ('red', 'orange', 'yellow', 'green', 'blue', 'purple
      <row>
       <entry role="func_table_entry">
        <para role="func_signature">
-        <type>gen_random_uuid</type>
+        <type>gen_random_uuid ()</type>
         <returnvalue>uuid</returnvalue>
        </para>
        <para role="func_signature">
-        <type>uuidv4</type>
+        <type>uuidv4 ()</type>
         <returnvalue>uuid</returnvalue>
        </para>
        <para>
#2Marcos Pegoraro
marcos@f10.com.br
In reply to: Marcos Pegoraro (#1)
1 attachment(s)
Re: Missing parentheses

Em qui., 25 de set. de 2025 às 10:55, Marcos Pegoraro <marcos@f10.com.br>
escreveu:

New version for removing spaces between function names and parentheses

Attachments:

patch.diffapplication/octet-stream; name=patch.diffDownload
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 8a347bec62c..02877e808ce 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -14437,11 +14437,11 @@ CREATE TYPE rainbow AS ENUM ('red', 'orange', 'yellow', 'green', 'blue', 'purple
      <row>
       <entry role="func_table_entry">
        <para role="func_signature">
-        <type>gen_random_uuid</type>
+        <type>gen_random_uuid()</type>
         <returnvalue>uuid</returnvalue>
        </para>
        <para role="func_signature">
-        <type>uuidv4</type>
+        <type>uuidv4()</type>
         <returnvalue>uuid</returnvalue>
        </para>
        <para>
#3Chao Li
li.evan.chao@gmail.com
In reply to: Marcos Pegoraro (#2)
Re: Missing parentheses

Hi Marcos,

The change looks good to me. People usually create a patch file by:

$ git checkout -b <a-branch-name>
$ git commit # create a commit for your change
$ git format-patch -v1 master # it will generate a patch file and attach the patch file in your email

For more details, see https://wiki.postgresql.org/wiki/Submitting_a_Patch.

On Sep 25, 2025, at 22:13, Marcos Pegoraro <marcos@f10.com.br> wrote:

Em qui., 25 de set. de 2025 às 10:55, Marcos Pegoraro <marcos@f10.com.br <mailto:marcos@f10.com.br>> escreveu:

New version for removing spaces between function names and parentheses
<patch.diff>

Best regards,
--
Chao Li (Evan)
HighGo Software Co., Ltd.
https://www.highgo.com/

#4Marcos Pegoraro
marcos@f10.com.br
In reply to: Chao Li (#3)
Re: Missing parentheses

Em qui., 25 de set. de 2025 às 11:20, Chao Li <li.evan.chao@gmail.com>
escreveu:

People usually create a patch file by:

Thanks, I'll remember next time

regards
Marcos

#5Tom Lane
tgl@sss.pgh.pa.us
In reply to: Marcos Pegoraro (#2)
Re: Missing parentheses

Marcos Pegoraro <marcos@f10.com.br> writes:

New version for removing spaces between function names and parentheses

Hmph, this documentation section needs work doesn't it.
Aside from the lack of parens, it's using <type> to label
functions, the layout is a poor match to what we do elsewhere,
and the grammar is pretty inconsistent.

Will try to clean it up.

regards, tom lane

#6Marcos Pegoraro
marcos@f10.com.br
In reply to: Tom Lane (#5)
Re: Missing parentheses

Em qui., 25 de set. de 2025 às 12:14, Tom Lane <tgl@sss.pgh.pa.us> escreveu:

Will try to clean it up.

On Sep-25 Tom commited some changes on file \doc\src\sgml\func.sgml
but that commit did not change the correspondent HTML

What needs to be done to be published ?

regards
Marcos

#7Bruce Momjian
bruce@momjian.us
In reply to: Marcos Pegoraro (#6)
Re: Missing parentheses

On Sat, Nov 1, 2025 at 10:51:15AM -0300, Marcos Pegoraro wrote:

Em qui., 25 de set. de 2025 às 12:14, Tom Lane <tgl@sss.pgh.pa.us> escreveu:

Will try to clean it up.

On Sep-25 Tom commited some changes on file \doc\src\sgml\func.sgml
but that commit did not change the correspondent HTML 

What needs to be done to be published ?

So, it was this commit, backpatched to PG 18:

commit 507aa16125c
Author: Tom Lane <tgl@sss.pgh.pa.us>
Date: Thu Sep 25 11:23:27 2025 -0400

Doc: clean up documentation for new UUID functions.

Fix assorted failures to conform to our normal style for function
documentation, such as lack of parentheses and incorrect markup.

Author: Marcos Pegoraro <marcos@f10.com.br>
Co-authored-by: Tom Lane <tgl@sss.pgh.pa.us>
Discussion: /messages/by-id/CAB-JLwbocrFjKfGHoKY43pHTf49Ca2O0j3WVebC8z-eQBMPJyw@mail.gmail.com
Backpatch-through: 18

The PG 18 changes will appear once we rebuild the PG 18 docs as part of
the 18 minor release. The next PG 18 minor release is scheduled for
November 13th, 2025:

https://www.postgresql.org/developer/roadmap/

The docs on master, which this patch was also applied on, is rebuilt
every night, so you should see it here:

https://www.postgresql.org/docs/devel/

--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EDB https://enterprisedb.com

Do not let urgent matters crowd out time for investment in the future.

#8Marcos Pegoraro
marcos@f10.com.br
In reply to: Bruce Momjian (#7)
Re: Missing parentheses

Em sáb., 1 de nov. de 2025 às 11:29, Bruce Momjian <bruce@momjian.us>
escreveu:

The PG 18 changes will appear once we rebuild the PG 18 docs as part of
the 18 minor release. The next PG 18 minor release is scheduled for
November 13th, 2025:

The docs on master, which this patch was also applied on, is rebuilt
every night, so you should see it here:

good to know

thanks Bruce

regards
Macos