Re: Inconsistent "<acronym>" use

From: Noah Misch <noah(at)leadboat(dot)com>
To: Tatsuo Ishii <ishii(at)sraoss(dot)co(dot)jp>
Cc: pgsql-hackers(at)lists(dot)postgresql(dot)org
Subject: Re: Inconsistent "<acronym>" use
Date: 2021-01-10 21:11:07
Message-ID: 20210110211107.GA270892@rfd.leadboat.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: 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.

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Thomas Munro 2021-01-10 21:22:48 Re: [PATCH] Automatic HASH and LIST partition creation
Previous Message Andreas Karlsson 2021-01-10 21:06:25 Re: zstd compression for pg_dump