Re: documentation structure

From: Heikki Linnakangas <hlinnaka(at)iki(dot)fi>
To: jian he <jian(dot)universality(at)gmail(dot)com>, Dagfinn Ilmari Mannsåker <ilmari(at)ilmari(dot)org>
Cc: pgsql-hackers(at)postgresql(dot)org
Subject: Re: documentation structure
Date: 2024-11-04 16:42:24
Message-ID: c03b9a29-88ae-4f22-a611-374664c33b5c@iki.fi
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On 30/09/2024 11:15, jian he wrote:
> In, 0001-func.sgml-Consistently-use-optional-to-indicate-opti.patch
>
> -<function>format</function>(<parameter>formatstr</parameter>
> <type>text</type> [, <parameter>formatarg</parameter>
> <type>"any"</type> [, ...] ])
> +<function>format</function>(<parameter>formatstr</parameter>
> <type>text</type> <optional>, <parameter>formatarg</parameter>
> <type>"any"</type> [, ...] </optional>)
>
> i change it further to
> +<function>format</function>(<parameter>formatstr</parameter>
> <type>text</type> <optional>, <parameter>formatarg</parameter>
> <type>"any"</type> <optional>, ...</optional> </optional>)
>
> i did these kind of change to <function>format</function>,
> <function>concat_ws</function>, <function>concat</function>
>
> I've rebased your patch,
> added a commitfest entry: https://commitfest.postgresql.org/50/5278/
> it seems I cannot mark you as the author in commitfest.
> anyway, you ( Dagfinn Ilmari Mannsåker ) are the author of it.

Committed, thanks!

One funny case remains:

<entry role="func_table_entry"><para role="func_signature">
<function>unnest</function> ( <type>anyarray</type>,
<type>anyarray</type> <optional>, ... </optional> )
<returnvalue>setof anyelement, anyelement [, ... ]</returnvalue>
</para>
<para>

The returnvalue contains brackets. I tried to change that to use
"<optional>" tag too, but it's not valid:

postgres.sgml:20552: element returnvalue: validity error : Element
optional is not declared in returnvalue list of possible children

--
Heikki Linnakangas
Neon (https://neon.tech)

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Robert Haas 2024-11-04 16:53:20 Re: pgsql: Implement pg_wal_replay_wait() stored procedure
Previous Message Peter Geoghegan 2024-11-04 16:41:33 Re: Adding skip scan (including MDAM style range skip scan) to nbtree