Horton

Re: documentation structure

Heikki Linnakangas <hlinnaka@iki.fi>

View thread
From: Heikki Linnakangas <hlinnaka@iki.fi>
To: jian he <jian.universality@gmail.com>, Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
Cc: pgsql-hackers@postgresql.org
Date: 2024-11-04T16:42:24Z
Lists: pgsql-hackers

Commits

Same data as JSON: GET /api/v1/messages/:b64id/commits the thread's linked commits as JSON, with link sources. API reference →

  1. docs: Consistently use <optional> to indicate optional parameters

  2. docs: Consolidate into new "WAL for Extensions" chapter.

  3. freespace: Don't return blocks past the end of the main fork.

  4. docs: Merge separate chapters on built-in index AMs into one.

  5. docs: Demote "Monitoring Disk Usage" from chapter to section.

  6. doc: move system views section to its own chapter

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)