Re: remove endterms and title ids

From: Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org>
To: Peter Eisentraut <peter(dot)eisentraut(at)2ndquadrant(dot)com>
Cc: pgsql-docs <pgsql-docs(at)postgresql(dot)org>
Subject: Re: remove endterms and title ids
Date: 2017-12-20 19:00:54
Message-ID: 20171220190054.tujmp6uyzhx6o45f@alvherre.pgsql
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

Peter Eisentraut wrote:
> The attached patch removes endterm attributes from xref elements and the
> associated id attributes on title elements.
>
> Older documentation toolchains could not automatically generate text for
> xrefs into refentries, so we had to use the endterm attribute to tell it
> which text to create. This is no longer necessary and can be removed.
> In most cases, we can just rely on the automatically generated text.

So we had
There are several caveats to be aware of when using this option — see
_Building Indexes Concurrently_.

and with this patch we end up with
There are several caveats to be aware of when using this option — see
_the section called “Building Indexes Concurrently”_.

which looks pretty ugly to me. I think getting rid of the
mostly-pointless id attributes is a good motivation, but I wonder if
there's a way to retain the text as originally generated.

--
Álvaro Herrera https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Michael Paquier 2017-12-21 00:58:33 Re: Missing column_constraint explanation
Previous Message PG Doc comments form 2017-12-20 09:08:16 Missing column_constraint explanation