Re: remove endterms and title ids - Mailing list pgsql-docs

From Alvaro Herrera
Subject Re: remove endterms and title ids
Date
Msg-id 20171220190054.tujmp6uyzhx6o45f@alvherre.pgsql
Whole thread Raw
In response to remove endterms and title ids  (Peter Eisentraut <peter.eisentraut@2ndquadrant.com>)
Responses Re: remove endterms and title ids  (Alvaro Herrera <alvherre@alvh.no-ip.org>)
List 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


pgsql-docs by date:

Previous
From: PG Doc comments form
Date:
Subject: Missing column_constraint explanation
Next
From: Michael Paquier
Date:
Subject: Re: Missing column_constraint explanation