Re: Fix incorrect UUID index entry in function documentation

From: Fujii Masao <masao(dot)fujii(at)oss(dot)nttdata(dot)com>
To: Masahiko Sawada <sawada(dot)mshk(at)gmail(dot)com>
Cc: pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: Fix incorrect UUID index entry in function documentation
Date: 2025-06-23 14:40:36
Message-ID: 274659ec-3eed-40fb-85d3-bc35014c57a1@oss.nttdata.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On 2025/06/21 9:55, Masahiko Sawada wrote:
> On Fri, Jun 20, 2025 at 11:33 PM Fujii Masao
> <masao(dot)fujii(at)oss(dot)nttdata(dot)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

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Daniel Gustafsson 2025-06-23 14:52:01 Re: Fix incorrect UUID index entry in function documentation
Previous Message Tom Lane 2025-06-21 21:24:35 Re: Document if width_bucket's low and high are inclusive/exclusive