Re: [PATCH] add link to domain data types section from locale documentation

From: Laurenz Albe <laurenz(dot)albe(at)cybertec(dot)at>
To: Anton Voloshin <a(dot)voloshin(at)postgrespro(dot)ru>, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: [PATCH] add link to domain data types section from locale documentation
Date: 2021-05-27 07:45:27
Message-ID: 3b80ddf5a978bf084401e61288210d2fa3e75f37.camel@cybertec.at
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Thu, 2021-04-01 at 11:45 +0300, Anton Voloshin wrote:
> On 01.04.2021 11:29, Jürgen Purtz wrote:
> > It's likely that the term "domain" within an SQL context confuse some
> > people. An additional remark in the glossary concerning the SQL and IP
> > meaning may be helpful.
>
> Nice touch, thanks!

I have had a look at the patch.

The addition to the glossary is good.

I spotted this in "src/sgml/glossary.sgml":

<glossentry id="glossary-constraint">
<glossterm>Constraint</glossterm>
<glossdef>
<para>
A restriction on the values of data allowed within a
<glossterm linkend="glossary-table">table</glossterm>,
or in attributes of a
<!-- XXX Should have term "domain". Need term "type" for that. -->
<firstterm>domain</firstterm>.
</para>
<para>
For more information, see
<xref linkend="ddl-constraints"/>.
</para>
</glossdef>
</glossentry>

You should add a link to the new "domain" entry from there.
I think the comment should be removed.

I like the new link from "src/sgml/charset.sgml", but I think that
there are a few other places in the documentation that are likely to be
read by people who don't know about SQL domains and could benefit from such
a link:

- src/sgml/earthdistance.sgml

- src/sgml/lo.sgml

- src/sgml/information_schema.sgml (the entries about "check_constraints",
"column_domain_usage", "data_type_privileges", "domain_constraints",
"domain_catalog", "domain_udt_usage", "domains" and the description below
"columns")

This selection is a bit arbitrary, I admit.

Yours,
Laurenz Albe

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message 近藤雄太 2021-05-27 10:21:16 Re: Error building for 64-bit Windows (10)
Previous Message Laurenz Albe 2021-05-27 06:59:53 Re: [PATCH] fix ICU explorer link in locale documentation