public inbox for [email protected]
help / color / mirror / Atom feedFrom: Daniel Gustafsson <[email protected]>
To: Tom Lane <[email protected]>
Cc: [email protected]
Subject: Re: Change pg_attribute textual link to an actual link
Date: Mon, 22 Oct 2018 12:09:41 +0200
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>
References: <[email protected]>
<[email protected]>
> On 22 Oct 2018, at 01:27, Tom Lane <[email protected]> wrote:
>
> Daniel Gustafsson <[email protected]> writes:
>> In the System catalog/pg_attrdef documentation, there is a reference to
>> pg_attribute with the text "see below". That makes sense in the PDF version
>> (and similar renderings), but in the web version it seems a bit odd as
>> pg_attribute is on the next page, not below.
>
>> The attached patch changes it to an actual link instead, but simply removing
>> the "see below" bit is another approach which isn't out of line with other
>> parts of the documentation (I opted for link since I personally prefer that).
>
> I agree with your change, but I wonder if the sentence after this one
> doesn't need some work too. It seems to predate ALTER COLUMN SET DEFAULT.
> We could add a mention of that, or just stop trying to describe the
> preconditions, and say something like "only columns for which a default
> value has been explicitly set will have an entry here”.
I think your latter suggestion pretty much covers all we need, so updated the
patch with that too.
cheers ./daniel
Attachments:
[application/octet-stream] pg_attrdef_link-v2.patch (1.4K, 2-pg_attrdef_link-v2.patch)
download | inline diff:
From 984059ddae5f6009dcc3ff83a35843bf83a2091a Mon Sep 17 00:00:00 2001
From: Daniel Gustafsson <[email protected]>
Date: Sun, 21 Oct 2018 22:12:26 +0200
Subject: [PATCH] Turn a textual reference into an actual link
The "see below" reference to pg_attribute in the pg_attrdef docs is
a bit misleading in a web rendering, as there is no content below but
instead on another page. This changes the textual link into an actual
link to it clearer. Also reword sentence describing which columns are
represented in the catalog.
---
doc/src/sgml/catalogs.sgml | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml
index 6d6fbecd12..b02494be8a 100644
--- a/doc/src/sgml/catalogs.sgml
+++ b/doc/src/sgml/catalogs.sgml
@@ -902,10 +902,9 @@
<para>
The catalog <structname>pg_attrdef</structname> stores column default values. The main information
- about columns is stored in <structname>pg_attribute</structname>
- (see below). Only columns that explicitly specify a default value
- (when the table is created or the column is added) will have an
- entry here.
+ about columns is stored in <link linkend="catalog-pg-attribute"><structname>pg_attribute</structname></link>.
+ Only columns for which a default value has been explicitly set will have
+ an entry here.
</para>
<table>
--
2.14.1.145.gb3622a4ee
view thread (5+ messages) latest in thread
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], [email protected]
Subject: Re: Change pg_attribute textual link to an actual link
In-Reply-To: <[email protected]>
* 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