pgsql: Doc: standardize markup a bit more. - Mailing list pgsql-committers

From Tom Lane
Subject pgsql: Doc: standardize markup a bit more.
Date
Msg-id E1jVfCm-0005vc-Ln@gemulon.postgresql.org
Whole thread Raw
List 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(-)


pgsql-committers by date:

Previous
From: Tom Lane
Date:
Subject: pgsql: Doc: update sections 9.22 - 9.30 for new function table layout.
Next
From: Peter Geoghegan
Date:
Subject: pgsql: Add posting list tuple amcheck test case.