Re: Count parameter for cursor_to_xml - Mailing list pgsql-docs

From Daniel Gustafsson
Subject Re: Count parameter for cursor_to_xml
Date
Msg-id A8D93530-D57D-4AB9-8627-C5B16984A6AB@yesql.se
Whole thread Raw
In response to Count parameter for cursor_to_xml  (PG Doc comments form <noreply@postgresql.org>)
List pgsql-docs
> On 25 Sep 2024, at 10:50, PG Doc comments form <noreply@postgresql.org> wrote:
>
> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/16/functions-xml.html
> Description:
>
> cursor_to_xml ( cursor refcursor, count integer, nulls boolean,
>                tableforest boolean, targetns text ) → xml
>
> There is not explanation what the count parameter do.

It's described in the function text without the name of the parameter being
explicitly mentioned:

    "cursor_to_xml fetches the indicated number of rows from the cursor
    specified by the parameter cursor"

That could be rewritten to include the name of the parameter like: "fetches the
number of rows indicated by the parameter count from the cursor specified by
the parameter cursor".  We do mention every other parameter explicitly so it
would make sense to do so here as well.

--
Daniel Gustafsson




pgsql-docs by date:

Previous
From: PG Doc comments form
Date:
Subject: Count parameter for cursor_to_xml
Next
From: Egor Rogov
Date:
Subject: Parallel safety restriction in 17