Re: Change pg_attribute textual link to an actual link

From: Daniel Gustafsson <daniel(at)yesql(dot)se>
To: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Cc: pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: Change pg_attribute textual link to an actual link
Date: 2018-10-22 10:09:41
Message-ID: 5ABDB96A-B369-4954-AAE0-1354CBBB305F@yesql.se
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

> On 22 Oct 2018, at 01:27, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> wrote:
>
> Daniel Gustafsson <daniel(at)yesql(dot)se> 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

Attachment Content-Type Size
pg_attrdef_link-v2.patch application/octet-stream 1.4 KB

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Liudmila Mantrova 2018-10-22 16:14:36 Re: Proposed HTML Documentation Styles
Previous Message PG Doc comments form 2018-10-22 08:42:27 INSERT INTO RETURNING SYNTAX ERROR