Re: Inconsistent "<acronym>" use

From: Bruce Momjian <bruce(at)momjian(dot)us>
To: Noah Misch <noah(at)leadboat(dot)com>
Cc: Tatsuo Ishii <ishii(at)sraoss(dot)co(dot)jp>, pgsql-hackers(at)lists(dot)postgresql(dot)org
Subject: Re: Inconsistent "<acronym>" use
Date: 2021-01-10 23:23:41
Message-ID: 20210110232341.GA4320@momjian.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Sun, Jan 10, 2021 at 01:11:07PM -0800, Noah Misch wrote:
> 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.

I think smallcaps is almost always a win for acronyms.

--
Bruce Momjian <bruce(at)momjian(dot)us> https://momjian.us
EnterpriseDB https://enterprisedb.com

The usefulness of a cup is in its emptiness, Bruce Lee

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Tom Lane 2021-01-11 00:02:40 Re: Inconsistent "<acronym>" use
Previous Message Tom Lane 2021-01-10 22:38:50 Re: Multiple hosts in connection string failed to failover in non-hot standby mode