pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedFrom: Fujii Masao <masao.fujii@oss.nttdata.com>
To: pgsql-docs@lists.postgresql.org
Subject: Fix incorrect UUID index entry in function documentation
Date: Fri, 20 Jun 2025 23:33:22 +0900
Message-ID: <f33e0493-5773-4296-87c5-7ce459054cfe@oss.nttdata.com> (raw)
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
view thread (7+ messages) latest in thread
Message-ID: <f33e0493-5773-4296-87c5-7ce459054cfe@oss.nttdata.com>
Permalink: ../f33e0493-5773-4296-87c5-7ce459054cfe@oss.nttdata.com/
Also on: postgresql.org/message-id/f33e0493-5773-4296-87c5-7ce459054cfe@oss.nttdata.com
reply
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: masao.fujii@oss.nttdata.com, pgsql-docs@lists.postgresql.org
Subject: Re: Fix incorrect UUID index entry in function documentation
In-Reply-To: <f33e0493-5773-4296-87c5-7ce459054cfe@oss.nttdata.com>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox