Re: Documentation weirdness

From: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
To: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Cc: "pgsql-general(at)lists(dot)postgresql(dot)org" <pgsql-general(at)lists(dot)postgresql(dot)org>
Subject: Re: Documentation weirdness
Date: 2026-03-02 23:27:35
Message-ID: CAKFQuwZ3VqKNsYRSsn9XO5MMHN=gc7qqUCcGQfhAAqBC4kC8Qw@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-general

On Mon, Mar 2, 2026 at 11:42 AM Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> wrote:

> "David G. Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com> writes:
> > On Monday, March 2, 2026, Peter J. Holzer <hjp-pgsql(at)hjp(dot)at> wrote:
> >> Would it be possible to set (column constraint) and (table constraint)
> >> in the normal body font instead of monospace? That would make it clearer
> >> that these phrases aren't part of the syntax but descriptive.
>
> > Not sure, but I don’t like that as the sole solution anyway. Too subtle.
>
> Agreed, but we could/should do it along with modifying the text.
> I thought your addition of "variant" was a good idea.
> I didn't look closely at the rest of your diff.
>
>
The apparent reason the entire row is monospace is because it's all within
a <term> element inside a <varlistentry>. We'd probably have to put
something around the <term> to make this work - I have no clue what if
anything that might be. If someone knows the solution here, ok, but the
wording change is more than enough to solve the problem (and this probably
the only instance of this "problem" in the docs) so I don't intend to go
diving down that rabbit hole.

<varlistentry id="sql-createtable-parms-primary-key">
<term><literal>PRIMARY KEY</literal> (column constraint)</term>
<term><literal>PRIMARY KEY...(table constraint)</term>

Can't just move the </term> before the (... constraint) labels.

David J.

In response to

Responses

Browse pgsql-general by date

  From Date Subject
Next Message David G. Johnston 2026-03-02 23:32:44 Re: Documentation weirdness
Previous Message Tom Lane 2026-03-02 18:42:26 Re: Documentation weirdness