Re: Docs: Create table description for constraints markup fix and label tweaks

From: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
To: PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Docs: Create table description for constraints markup fix and label tweaks
Date: 2026-04-03 17:57:27
Message-ID: CAKFQuwYda2RwHdzwbz3FcMs_2kaKn7skpuPzAd15h5DH1LfzQg@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Fri, Apr 3, 2026 at 10:18 AM David G. Johnston <
david(dot)g(dot)johnston(at)gmail(dot)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.
>
> [1]
> https://www.postgresql.org/message-id/CA+FnnTzeE30E4kfK4=+MLe4DBORu4CdYvPQgWUYakRxfwsbEtg@mail.gmail.com
>
>
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.

Also, the CF entry: https://commitfest.postgresql.org/patch/6648/

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.

Attachment Content-Type Size
v2-0002-pgsql-doc-Make-constraint-type-labels-not-match-s.patch application/octet-stream 4.4 KB
v2-0001-pgsql-doc-Fix-malformed-sgml-element-nesting-for-.patch application/octet-stream 2.7 KB

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message David G. Johnston 2026-04-03 18:18:50 Docs: Distinguish table and index storage parameters in CREATE TABLE
Previous Message Daniel Gustafsson 2026-04-03 17:56:46 Re: Changing the state of data checksums in a running cluster