Re: documentation structure

Heikki Linnakangas <hlinnaka(at)iki(dot)fi> writes:

> 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!

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

Yeah, I remember running into that, and deciding I couldn't be bothered
to try to learn enough about docbook to figure out if a solution was
possible.

- ilmari