Re: Get rid of "Section.N.N.N" on DOCs
Isaac Morland <isaac.morland@gmail.com>
From: Isaac Morland <isaac.morland@gmail.com>
To: "David G. Johnston" <david.g.johnston@gmail.com>
Cc: Marcos Pegoraro <marcos@f10.com.br>, PostgreSQL Hackers <pgsql-hackers@lists.postgresql.org>
Date: 2025-12-14T18:21:40Z
Lists: pgsql-hackers
Commits
Same data as JSON:
GET /api/v1/messages/:b64id/commits
the thread's linked commits as JSON, with link sources.
API reference →
-
doc: Change xref style to number only
- 70da87d334eb 10.0 cited
On Sun, 14 Dec 2025 at 12:35, David G. Johnston <david.g.johnston@gmail.com> wrote: > On Sun, Dec 14, 2025 at 10:30 AM Marcos Pegoraro <marcos@f10.com.br> > wrote: > >> There are places where links are mixed, some of them are auto >> explanatory, some don't, like on See Also of VACUUM >> vacuumdb <https://www.postgresql.org/docs/18/app-vacuumdb.html>, >> Section 19.10.2 >> <https://www.postgresql.org/docs/18/runtime-config-vacuum.html#RUNTIME-CONFIG-RESOURCE-VACUUM-COST> >> , Section 24.1.6 >> <https://www.postgresql.org/docs/18/routine-vacuuming.html#AUTOVACUUM>, >> Section 27.4.5 >> <https://www.postgresql.org/docs/18/progress-reporting.html#VACUUM-PROGRESS-REPORTING> >> , Section 27.4.2 >> <https://www.postgresql.org/docs/18/progress-reporting.html#CLUSTER-PROGRESS-REPORTING> >> >> For that we need only put a "xreflabel" tag on that target link. >> >> I can create a patch for all of them, but I would like to know why it's >> done this way. >> > > That would be great. I don't think it's intentional, just not everyone > knowing and thus failing to add the additional attribute. > Is there any way to do this automatically, not by editing all the references, but by changing how they're formatted? It seems to me that all links to the same section should have the same link text, which should be some combination of the section number and/or title/description. So ideally this would be a matter of changing how the link text is computed. If we rename a section, we presumably want all references to it to update accordingly.