Re: Inconsistent "" use - Mailing list pgsql-hackers

From Noah Misch
Subject Re: Inconsistent "" use
Date
Msg-id 20210110211107.GA270892@rfd.leadboat.com
Whole thread Raw
In response to Inconsistent "" use  (Tatsuo Ishii <ishii@sraoss.co.jp>)
Responses Re: Inconsistent "" use  (Bruce Momjian <bruce@momjian.us>)
List pgsql-hackers
On Sun, Jan 10, 2021 at 08:22:42PM +0900, Tatsuo Ishii wrote:
> In doc/src/sgml/func.sgml description of SHOW command use
> "<acronym>SQL</acronym>", while SET command description the same
> section does not use "<acronym>". Shouldn't the description of SET use
> "<acronym>" for "SQL" as well? Patch attached.

https://tdg.docbook.org/tdg/5.2/acronym.html suggests docbook formatters
either ignore that <acronym> or use it as a signal to substitute small caps.
I don't consider small caps an improvement for "SQL", so I'd prefer to never
use <acronym>SQL</acronym>.  <acronym> also makes the markup longer (though
one could mitigate that with an entity like &SQL).  However, standardizing on
either way is better than varying within the manual.



pgsql-hackers by date:

Previous
From: Andreas Karlsson
Date:
Subject: Re: zstd compression for pg_dump
Next
From: Thomas Munro
Date:
Subject: Re: [PATCH] Automatic HASH and LIST partition creation