Re: Docs: Create table description for constraints markup fix and label tweaks - Mailing list pgsql-hackers

From Dapeng Wang
Subject Re: Docs: Create table description for constraints markup fix and label tweaks
Date
Msg-id CAKx0YhzeEZKKgqn5_yBr5L7UxAf31Acw45PmSA6MsvVnw8vDeQ@mail.gmail.com
Whole thread
In response to Re: Docs: Create table description for constraints markup fix and label tweaks  ("David G. Johnston" <david.g.johnston@gmail.com>)
List pgsql-hackers
Hi David,

I reviewed both patches on the latest HEAD.

0001: SGML nesting fix applied and verified - make html
builds successfully with the corrected element nesting
for UNIQUE and PRIMARY KEY.

0002: The six "variant" label changes look good and should
help avoid the confusion reported on -general.

Looks good to me.

Regards,
Dapeng Wang

David G. Johnston <david.g.johnston@gmail.com> 于2026年4月10日周五 15:04写道:
On Fri, Apr 3, 2026 at 10:18 AM David G. Johnston <david.g.johnston@gmail.com> wrote:
Responding to a recent report on -general [1] I found a markup bug in the primary key description under create table.  0001 fixes this.

The complaint itself was about using "column constraint" as a descriptive label in a syntax area when "column constraint" is an actual defined syntax label.  0002 adds the word "variant" to the six places "(table/column constraint)" is used in this manner.



The more you look (not having production dark mode in the core build is a bit annoying)...v2 attached after re-reading the original thread and looking around a bit more.

Unique had the same sgml markup error as primary key.

 
David J.

P.S. Reviewing this we are inconsistent as to where we use "optional" markup versus just literal [ ].  Even among these three locations there are variances - and simply literals used for optional meaning brackets.

pgsql-hackers by date:

Previous
From: Rafia Sabih
Date:
Subject: Re: Bypassing cursors in postgres_fdw to enable parallel plans
Next
From: Michael Paquier
Date:
Subject: Re: Fix pgstat_database.c to honor passed database OIDs