pgsql: Doc: standardize markup a bit more.

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: Doc: standardize markup a bit more.
Date: 2020-05-04 17:48:36
Message-ID: E1jVfCm-0005vc-Ln@gemulon.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers

Doc: standardize markup a bit more.

We had a mishmash of <replaceable>, <replaceable class="parameter">,
and <parameter> markup for operator/function arguments. Use <parameter>
consistently for things that are in fact names of parameters (including
OUT parameters), reserving <replaceable> for things that aren't. The
latter class includes some made-up-by-the-docs type class names, like
"numeric_type", as well as placeholders for arguments that don't have
well-defined types. Possibly we could do better with those categories
as well, but for the moment I'm content not to have parameter names
marked up in different ways in different places.

(This commit aligns the earlier sections of chapter 9 with a policy
that I'd arrived at while working on commit 1ad23335f, which is why
the last few sections need no changes.)

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/47046763c3ed1f16b81a389df7e44be5f3dba83c

Modified Files
--------------
doc/src/sgml/func.sgml | 698 +++++++++++++++++++++++++------------------------
1 file changed, 351 insertions(+), 347 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Peter Geoghegan 2020-05-04 18:24:56 pgsql: Add posting list tuple amcheck test case.
Previous Message Tom Lane 2020-05-04 16:18:37 pgsql: Doc: update sections 9.22 - 9.30 for new function table layout.