public inbox for [email protected]
help / color / mirror / Atom feedChange pg_attribute textual link to an actual link
5+ messages / 3 participants
[nested] [flat]
* Change pg_attribute textual link to an actual link
@ 2018-10-21 20:29 Daniel Gustafsson <[email protected]>
2018-10-21 23:27 ` Re: Change pg_attribute textual link to an actual link Tom Lane <[email protected]>
0 siblings, 1 reply; 5+ messages in thread
From: Daniel Gustafsson @ 2018-10-21 20:29 UTC (permalink / raw)
To: [email protected]
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).
cheers ./daniel
Attachments:
[application/octet-stream] pg_attrdef_link.patch (1.2K, 2-pg_attrdef_link.patch)
download | inline diff:
From 1d3175a2e1dfa771124c2dd2f0565028b0732ef8 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.
---
doc/src/sgml/catalogs.sgml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml
index 6d6fbecd12..62d564755f 100644
--- a/doc/src/sgml/catalogs.sgml
+++ b/doc/src/sgml/catalogs.sgml
@@ -902,8 +902,8 @@
<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
+ about columns is stored in <link linkend="catalog-pg-attribute"><structname>pg_attribute</structname></link>.
+ Only columns that explicitly specify a default value
(when the table is created or the column is added) will have an
entry here.
</para>
--
2.14.1.145.gb3622a4ee
^ permalink raw reply [nested|flat] 5+ messages in thread
* Re: Change pg_attribute textual link to an actual link
2018-10-21 20:29 Change pg_attribute textual link to an actual link Daniel Gustafsson <[email protected]>
@ 2018-10-21 23:27 ` Tom Lane <[email protected]>
2018-10-22 10:09 ` Re: Change pg_attribute textual link to an actual link Daniel Gustafsson <[email protected]>
0 siblings, 1 reply; 5+ messages in thread
From: Tom Lane @ 2018-10-21 23:27 UTC (permalink / raw)
To: Daniel Gustafsson <[email protected]>; +Cc: [email protected]
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".
regards, tom lane
^ permalink raw reply [nested|flat] 5+ messages in thread
* Re: Change pg_attribute textual link to an actual link
2018-10-21 20:29 Change pg_attribute textual link to an actual link Daniel Gustafsson <[email protected]>
2018-10-21 23:27 ` Re: Change pg_attribute textual link to an actual link Tom Lane <[email protected]>
@ 2018-10-22 10:09 ` Daniel Gustafsson <[email protected]>
2018-10-29 07:39 ` Re: Change pg_attribute textual link to an actual link Michael Paquier <[email protected]>
0 siblings, 1 reply; 5+ messages in thread
From: Daniel Gustafsson @ 2018-10-22 10:09 UTC (permalink / raw)
To: Tom Lane <[email protected]>; +Cc: [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
^ permalink raw reply [nested|flat] 5+ messages in thread
* Re: Change pg_attribute textual link to an actual link
2018-10-21 20:29 Change pg_attribute textual link to an actual link Daniel Gustafsson <[email protected]>
2018-10-21 23:27 ` Re: Change pg_attribute textual link to an actual link Tom Lane <[email protected]>
2018-10-22 10:09 ` Re: Change pg_attribute textual link to an actual link Daniel Gustafsson <[email protected]>
@ 2018-10-29 07:39 ` Michael Paquier <[email protected]>
2018-10-29 10:00 ` Re: Change pg_attribute textual link to an actual link Daniel Gustafsson <[email protected]>
0 siblings, 1 reply; 5+ messages in thread
From: Michael Paquier @ 2018-10-29 07:39 UTC (permalink / raw)
To: Daniel Gustafsson <[email protected]>; +Cc: Tom Lane <[email protected]>; [email protected]
On Mon, Oct 22, 2018 at 12:09:41PM +0200, Daniel Gustafsson wrote:
> I think your latter suggestion pretty much covers all we need, so updated the
> patch with that too.
Both the patch and the suggestions made look good to me, so committed.
--
Michael
Attachments:
[application/pgp-signature] signature.asc (833B, 2-signature.asc)
download
^ permalink raw reply [nested|flat] 5+ messages in thread
* Re: Change pg_attribute textual link to an actual link
2018-10-21 20:29 Change pg_attribute textual link to an actual link Daniel Gustafsson <[email protected]>
2018-10-21 23:27 ` Re: Change pg_attribute textual link to an actual link Tom Lane <[email protected]>
2018-10-22 10:09 ` Re: Change pg_attribute textual link to an actual link Daniel Gustafsson <[email protected]>
2018-10-29 07:39 ` Re: Change pg_attribute textual link to an actual link Michael Paquier <[email protected]>
@ 2018-10-29 10:00 ` Daniel Gustafsson <[email protected]>
0 siblings, 0 replies; 5+ messages in thread
From: Daniel Gustafsson @ 2018-10-29 10:00 UTC (permalink / raw)
To: Michael Paquier <[email protected]>; +Cc: Tom Lane <[email protected]>; [email protected]
> On 29 Oct 2018, at 08:39, Michael Paquier <[email protected]> wrote:
>
> On Mon, Oct 22, 2018 at 12:09:41PM +0200, Daniel Gustafsson wrote:
>> I think your latter suggestion pretty much covers all we need, so updated the
>> patch with that too.
>
> Both the patch and the suggestions made look good to me, so committed.
Thanks! I updated the status in the CF app to Committed.
cheers ./daniel
^ permalink raw reply [nested|flat] 5+ messages in thread
end of thread, other threads:[~2018-10-29 10:00 UTC | newest]
Thread overview: 5+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2018-10-21 20:29 Change pg_attribute textual link to an actual link Daniel Gustafsson <[email protected]>
2018-10-21 23:27 ` Tom Lane <[email protected]>
2018-10-22 10:09 ` Daniel Gustafsson <[email protected]>
2018-10-29 07:39 ` Michael Paquier <[email protected]>
2018-10-29 10:00 ` Daniel Gustafsson <[email protected]>
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox