public inbox for [email protected]  
help / color / mirror / Atom feed
From: Peter J. Holzer <[email protected]>
To: [email protected]
Subject: Re: Documentation weirdness
Date: Mon, 2 Mar 2026 19:29:08 +0100
Message-ID: <4mdo74l7xtv7yezgtpn3okojofyf6ihqttjm67cwngyiadgjf2@c6aqv4ruxrqp> (raw)
In-Reply-To: <CAKFQuwbefYYr-e=jS6gLJbdo9nG47_tS-inbsCCFEFYpxV+U2w@mail.gmail.com>
References: <CA+FnnTzeE30E4kfK4=+MLe4DBORu4CdYvPQgWUYakRxfwsbEtg@mail.gmail.com>
	<CAKFQuwbefYYr-e=jS6gLJbdo9nG47_tS-inbsCCFEFYpxV+U2w@mail.gmail.com>

On 2026-03-01 19:08:48 -0700, David G. Johnston wrote:
> On Sun, Mar 1, 2026 at 6:38 PM Igor Korot <[email protected]> wrote:
> 
>     Hi, ALL,
>     I'm looking at https://www.postgresql.org/docs/current/sql-createtable.html
>     and see some weird stuff.
> 
>     When I try to search for "PRIMARY KEY" I eventually hit following:
> 
>     [quote]
>     PRIMARY KEY (column constraint)
>     PRIMARY KEY ( column_name [, ... ] [, column_name WITHOUT OVERLAPS ] )
>     [ INCLUDE ( column_name [, ...]) ] (table constraint)
>     [/quote]
> 
>     Now I want to check what "column_constraint" is.
> 
> 
> You read in an underscore in the parenthetical that isn't there.  That said, I
> concur that using a label here that so closely matches something that exists
> within the page, to mean something else, is just asking for this kind of
> confusion.

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.

        hjp

-- 
   _  | Peter J. Holzer    | Story must make more sense than reality.
|_|_) |                    |
| |   | [email protected]         |    -- Charles Stross, "Creative writing
__/   | http://www.hjp.at/ |       challenge!"


Attachments:

  [application/pgp-signature] signature.asc (833B, 2-signature.asc)
  download

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected]
  Subject: Re: Documentation weirdness
  In-Reply-To: <4mdo74l7xtv7yezgtpn3okojofyf6ihqttjm67cwngyiadgjf2@c6aqv4ruxrqp>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox