Re: A minor bug in the doc of "SQL Functions Returning Sets" in xfunc.sgml. - Mailing list pgsql-docs

From David G. Johnston
Subject Re: A minor bug in the doc of "SQL Functions Returning Sets" in xfunc.sgml.
Date
Msg-id CAKFQuwa3nNETFm23VjbX+2=aaBK7Am5Q0ZE3OsBXvYLorLw+Mg@mail.gmail.com
Whole thread Raw
In response to Re: A minor bug in the doc of "SQL Functions Returning Sets" in xfunc.sgml.  (Michael Paquier <michael@paquier.xyz>)
Responses Re: A minor bug in the doc of "SQL Functions Returning Sets" in xfunc.sgml.
List pgsql-docs
On Thu, Jul 18, 2024 at 7:10 PM Michael Paquier <michael@paquier.xyz> wrote:
On Fri, Jul 19, 2024 at 10:46:04AM +0900, 日向充 wrote:
> I have found executable examples that do not work correctly
> in the doc of "SQL Functions Returning Sets" in xfunc.sgml.
> So I fixed the examples as follows.


The attached patch is much more readable...

>
> The above will improve the results of examples as follows in this chapter.
>
> Do you think?

Not sure that this is worth changing.  The examples work OK when taken
in isolation or are able to demonstrate the point they want to show.
In short, not all these queries are here to be compatible with the
contents in the same area.  See for example the case of the "nodes"
table on the same page, created nowhere.  "tab" is just a more generic
table name that's more spread.


Clearly this page repeatedly expects tab.x to exist; and for these queries to be executable.  This seems like the least invasive way to make that expectation reality.  The extremely limited extent of nodes compared to tab on this page doesn't support using it as a reason to not make the tab examples work.  If anything we should add a create table for nodes for the reader like we did for tab.

I'd fixup [1] as to match, removing the name of the input parameter "x" since we use $1 anyway.  Getting rid of that now obsolete construction is a whole other patch.


David J.

pgsql-docs by date:

Previous
From: Michael Paquier
Date:
Subject: Re: A minor bug in the doc of "SQL Functions Returning Sets" in xfunc.sgml.
Next
From: Tom Lane
Date:
Subject: Re: A minor bug in the doc of "SQL Functions Returning Sets" in xfunc.sgml.