Re: Count parameter for cursor_to_xml

From: Daniel Gustafsson <daniel(at)yesql(dot)se>
To: splarv(at)ya(dot)ru, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: Count parameter for cursor_to_xml
Date: 2024-09-25 11:24:25
Message-ID: A8D93530-D57D-4AB9-8627-C5B16984A6AB@yesql.se
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

> On 25 Sep 2024, at 10:50, PG Doc comments form <noreply(at)postgresql(dot)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

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Oleg Tselebrovskiy 2024-09-25 15:13:24 Initcap works differently with different locale providers
Previous Message PG Doc comments form 2024-09-25 08:50:32 Count parameter for cursor_to_xml