agora inbox for pgsql-docs@postgresql.org
help / color / mirror / Atom feedFix incorrect UUID index entry in function documentation
7+ messages / 3 participants
[nested] [flat]
* Fix incorrect UUID index entry in function documentation
@ 2025-06-20 14:33 Fujii Masao <masao.fujii@oss.nttdata.com>
0 siblings, 1 reply; 7+ messages in thread
From: Fujii Masao @ 2025-06-20 14:33 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org
Hi,
Both the UUID data type and UUID functions pages define an index entry
for "UUID" that points to the data type section. As a result, the index
includes two identical entries linking to the UUID type docs,
which seems strange.
I believe the UUID functions page should instead define its own index
entry that links to itself. Currently, the indexterm is written as:
--------------------
<sect1 id="functions-uuid">
<title>UUID Functions</title>
<indexterm zone="datatype-uuid">
<primary>UUID</primary>
<secondary>generating</secondary>
</indexterm>
--------------------
I suspect that "datatype-uuid" is a copy-paste error and should be
"functions-uuid" to reflect the correct section. The attached patch
updates this accordingly.
Thoughts?
Regards,
--
Fujii Masao
NTT DATA Japan Corporation
From e4fbb1929ccb43ff3adc282893167a2df6cbc1d2 Mon Sep 17 00:00:00 2001
From: Fujii Masao <fujii@postgresql.org>
Date: Fri, 20 Jun 2025 22:54:52 +0900
Subject: [PATCH v1] doc: Fix incorrect UUID index entry in function
documentation.
Previously, the UUID functions documentation defined the "UUID" index entry
to link to the UUID data type page, even though that entry already exists there.
Instead, the UUID functions page should define its own index entry linking
to itself.
This commit updates the UUID index entry in the UUID functions documentation
to point to the correct section, improving navigation and avoiding duplication.
Back-patch to all supported versions.
---
doc/src/sgml/func.sgml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 8d7d9a2f3e8..a0b9044e358 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -14374,7 +14374,7 @@ CREATE TYPE rainbow AS ENUM ('red', 'orange', 'yellow', 'green', 'blue', 'purple
<sect1 id="functions-uuid">
<title>UUID Functions</title>
- <indexterm zone="datatype-uuid">
+ <indexterm zone="functions-uuid">
<primary>UUID</primary>
<secondary>generating</secondary>
</indexterm>
--
2.49.0
Attachments:
[text/plain] v1-0001-doc-Fix-incorrect-UUID-index-entry-in-function-do.patch (1.2K, ../../f33e0493-5773-4296-87c5-7ce459054cfe@oss.nttdata.com/2-v1-0001-doc-Fix-incorrect-UUID-index-entry-in-function-do.patch)
download | inline diff:
From e4fbb1929ccb43ff3adc282893167a2df6cbc1d2 Mon Sep 17 00:00:00 2001
From: Fujii Masao <fujii@postgresql.org>
Date: Fri, 20 Jun 2025 22:54:52 +0900
Subject: [PATCH v1] doc: Fix incorrect UUID index entry in function
documentation.
Previously, the UUID functions documentation defined the "UUID" index entry
to link to the UUID data type page, even though that entry already exists there.
Instead, the UUID functions page should define its own index entry linking
to itself.
This commit updates the UUID index entry in the UUID functions documentation
to point to the correct section, improving navigation and avoiding duplication.
Back-patch to all supported versions.
---
doc/src/sgml/func.sgml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 8d7d9a2f3e8..a0b9044e358 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -14374,7 +14374,7 @@ CREATE TYPE rainbow AS ENUM ('red', 'orange', 'yellow', 'green', 'blue', 'purple
<sect1 id="functions-uuid">
<title>UUID Functions</title>
- <indexterm zone="datatype-uuid">
+ <indexterm zone="functions-uuid">
<primary>UUID</primary>
<secondary>generating</secondary>
</indexterm>
--
2.49.0
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: Fix incorrect UUID index entry in function documentation
@ 2025-06-21 00:55 Masahiko Sawada <sawada.mshk@gmail.com>
parent: Fujii Masao <masao.fujii@oss.nttdata.com>
0 siblings, 1 reply; 7+ messages in thread
From: Masahiko Sawada @ 2025-06-21 00:55 UTC (permalink / raw)
To: Fujii Masao <masao.fujii@oss.nttdata.com>; +Cc: pgsql-docs@lists.postgresql.org
On Fri, Jun 20, 2025 at 11:33 PM Fujii Masao
<masao.fujii@oss.nttdata.com> wrote:
>
> Hi,
>
> Both the UUID data type and UUID functions pages define an index entry
> for "UUID" that points to the data type section. As a result, the index
> includes two identical entries linking to the UUID type docs,
> which seems strange.
>
> I believe the UUID functions page should instead define its own index
> entry that links to itself. Currently, the indexterm is written as:
>
> --------------------
> <sect1 id="functions-uuid">
> <title>UUID Functions</title>
>
> <indexterm zone="datatype-uuid">
> <primary>UUID</primary>
> <secondary>generating</secondary>
> </indexterm>
> --------------------
>
> I suspect that "datatype-uuid" is a copy-paste error and should be
> "functions-uuid" to reflect the correct section. The attached patch
> updates this accordingly.
>
> Thoughts?
+1. I think it also makes sense that "UUID generating" has the link to
"UUID Functions".
Regards,
--
Masahiko Sawada
Amazon Web Services: https://aws.amazon.com
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: Fix incorrect UUID index entry in function documentation
@ 2025-06-23 14:40 Fujii Masao <masao.fujii@oss.nttdata.com>
parent: Masahiko Sawada <sawada.mshk@gmail.com>
0 siblings, 1 reply; 7+ messages in thread
From: Fujii Masao @ 2025-06-23 14:40 UTC (permalink / raw)
To: Masahiko Sawada <sawada.mshk@gmail.com>; +Cc: pgsql-docs@lists.postgresql.org
On 2025/06/21 9:55, Masahiko Sawada wrote:
> On Fri, Jun 20, 2025 at 11:33 PM Fujii Masao
> <masao.fujii@oss.nttdata.com> wrote:
>>
>> Hi,
>>
>> Both the UUID data type and UUID functions pages define an index entry
>> for "UUID" that points to the data type section. As a result, the index
>> includes two identical entries linking to the UUID type docs,
>> which seems strange.
>>
>> I believe the UUID functions page should instead define its own index
>> entry that links to itself. Currently, the indexterm is written as:
>>
>> --------------------
>> <sect1 id="functions-uuid">
>> <title>UUID Functions</title>
>>
>> <indexterm zone="datatype-uuid">
>> <primary>UUID</primary>
>> <secondary>generating</secondary>
>> </indexterm>
>> --------------------
>>
>> I suspect that "datatype-uuid" is a copy-paste error and should be
>> "functions-uuid" to reflect the correct section. The attached patch
>> updates this accordingly.
>>
>> Thoughts?
>
> +1. I think it also makes sense that "UUID generating" has the link to
> "UUID Functions".
Yes, and the proposed change ensures that as well.
So barring any objections, I will commit the patch.
Regards,
--
Fujii Masao
NTT DATA Japan Corporation
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: Fix incorrect UUID index entry in function documentation
@ 2025-06-23 14:52 Daniel Gustafsson <daniel@yesql.se>
parent: Fujii Masao <masao.fujii@oss.nttdata.com>
0 siblings, 1 reply; 7+ messages in thread
From: Daniel Gustafsson @ 2025-06-23 14:52 UTC (permalink / raw)
To: Fujii Masao <masao.fujii@oss.nttdata.com>; +Cc: Masahiko Sawada <sawada.mshk@gmail.com>; pgsql-docs@lists.postgresql.org
> On 23 Jun 2025, at 16:40, Fujii Masao <masao.fujii@oss.nttdata.com> wrote:
> So barring any objections, I will commit the patch.
+1, LGTM. There is one more occurrence though, the relnotes seem to need the
same treatment as they talk about UUID functions and not the UUID datatype:
diff --git a/doc/src/sgml/release-18.sgml b/doc/src/sgml/release-18.sgml
index 662c7d8890f..fba01d3ca44 100644
--- a/doc/src/sgml/release-18.sgml
+++ b/doc/src/sgml/release-18.sgml
@@ -2498,7 +2498,7 @@ Author: Masahiko Sawada <msawada@postgresql.org>
<listitem>
<para>
- Add <link linkend="datatype-uuid"><type>UUID</type></link>
+ Add <link linkend="functions-uuid"><type>UUID</type></link>
version 7 generation function <link
linkend="func_uuid_gen_table"><function>uuidv7()</function></link>
(Andrey Borodin)
--
Daniel Gustafsson
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: Fix incorrect UUID index entry in function documentation
@ 2025-06-23 15:46 Fujii Masao <masao.fujii@oss.nttdata.com>
parent: Daniel Gustafsson <daniel@yesql.se>
0 siblings, 1 reply; 7+ messages in thread
From: Fujii Masao @ 2025-06-23 15:46 UTC (permalink / raw)
To: Daniel Gustafsson <daniel@yesql.se>; +Cc: Masahiko Sawada <sawada.mshk@gmail.com>; pgsql-docs@lists.postgresql.org
On 2025/06/23 23:52, Daniel Gustafsson wrote:
>> On 23 Jun 2025, at 16:40, Fujii Masao <masao.fujii@oss.nttdata.com> wrote:
>
>> So barring any objections, I will commit the patch.
>
> +1, LGTM.
Thanks for the review!
> There is one more occurrence though, the relnotes seem to need the
> same treatment as they talk about UUID functions and not the UUID datatype:
>
> diff --git a/doc/src/sgml/release-18.sgml b/doc/src/sgml/release-18.sgml
> index 662c7d8890f..fba01d3ca44 100644
> --- a/doc/src/sgml/release-18.sgml
> +++ b/doc/src/sgml/release-18.sgml
> @@ -2498,7 +2498,7 @@ Author: Masahiko Sawada <msawada@postgresql.org>
>
> <listitem>
> <para>
> - Add <link linkend="datatype-uuid"><type>UUID</type></link>
> + Add <link linkend="functions-uuid"><type>UUID</type></link>
> version 7 generation function <link
> linkend="func_uuid_gen_table"><function>uuidv7()</function></link>
> (Andrey Borodin)
That "UUID" here seems to refer to the general concept, so I don't think
it needs to link specifically to the UUID functions page. Since the UUID
data type page already provides a basic explanation, it makes sense for
the link to point there. Also, since "uuidv7()" and "uuidv4()" there
already link to the UUID functions page, that seems sufficient to me.
Thought?
Regards,
--
Fujii Masao
NTT DATA Japan Corporation
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: Fix incorrect UUID index entry in function documentation
@ 2025-06-24 05:37 Fujii Masao <masao.fujii@oss.nttdata.com>
parent: Fujii Masao <masao.fujii@oss.nttdata.com>
0 siblings, 1 reply; 7+ messages in thread
From: Fujii Masao @ 2025-06-24 05:37 UTC (permalink / raw)
To: Daniel Gustafsson <daniel@yesql.se>; +Cc: Masahiko Sawada <sawada.mshk@gmail.com>; pgsql-docs@lists.postgresql.org
On 2025/06/24 0:46, Fujii Masao wrote:
>
>
> On 2025/06/23 23:52, Daniel Gustafsson wrote:
>>> On 23 Jun 2025, at 16:40, Fujii Masao <masao.fujii@oss.nttdata.com> wrote:
>>
>>> So barring any objections, I will commit the patch.
>>
>> +1, LGTM.
>
> Thanks for the review!
>
>> There is one more occurrence though, the relnotes seem to need the
>> same treatment as they talk about UUID functions and not the UUID datatype:
>>
>> diff --git a/doc/src/sgml/release-18.sgml b/doc/src/sgml/release-18.sgml
>> index 662c7d8890f..fba01d3ca44 100644
>> --- a/doc/src/sgml/release-18.sgml
>> +++ b/doc/src/sgml/release-18.sgml
>> @@ -2498,7 +2498,7 @@ Author: Masahiko Sawada <msawada@postgresql.org>
>>
>> <listitem>
>> <para>
>> - Add <link linkend="datatype-uuid"><type>UUID</type></link>
>> + Add <link linkend="functions-uuid"><type>UUID</type></link>
>> version 7 generation function <link
>> linkend="func_uuid_gen_table"><function>uuidv7()</function></link>
>> (Andrey Borodin)
>
> That "UUID" here seems to refer to the general concept, so I don't think
> it needs to link specifically to the UUID functions page. Since the UUID
> data type page already provides a basic explanation, it makes sense for
> the link to point there. Also, since "uuidv7()" and "uuidv4()" there
> already link to the UUID functions page, that seems sufficient to me.
> Thought?
I've committed the proposed patch first. If we later agree to change
this part as well, we can commit that separately.
Regards,
--
Fujii Masao
NTT DATA Japan Corporation
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: Fix incorrect UUID index entry in function documentation
@ 2025-06-24 07:21 Daniel Gustafsson <daniel@yesql.se>
parent: Fujii Masao <masao.fujii@oss.nttdata.com>
0 siblings, 0 replies; 7+ messages in thread
From: Daniel Gustafsson @ 2025-06-24 07:21 UTC (permalink / raw)
To: Fujii Masao <masao.fujii@oss.nttdata.com>; +Cc: Masahiko Sawada <sawada.mshk@gmail.com>; pgsql-docs@lists.postgresql.org
> On 24 Jun 2025, at 07:37, Fujii Masao <masao.fujii@oss.nttdata.com> wrote:
> I've committed the proposed patch first. If we later agree to change
> this part as well, we can commit that separately.
What you committed is perfectly fine, thanks!
--
Daniel Gustafsson
^ permalink raw reply [nested|flat] 7+ messages in thread
end of thread, other threads:[~2025-06-24 07:21 UTC | newest]
Thread overview: 7+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2025-06-20 14:33 Fix incorrect UUID index entry in function documentation Fujii Masao <masao.fujii@oss.nttdata.com>
2025-06-21 00:55 ` Masahiko Sawada <sawada.mshk@gmail.com>
2025-06-23 14:40 ` Fujii Masao <masao.fujii@oss.nttdata.com>
2025-06-23 14:52 ` Daniel Gustafsson <daniel@yesql.se>
2025-06-23 15:46 ` Fujii Masao <masao.fujii@oss.nttdata.com>
2025-06-24 05:37 ` Fujii Masao <masao.fujii@oss.nttdata.com>
2025-06-24 07:21 ` Daniel Gustafsson <daniel@yesql.se>
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox