Re: A minor bug in the doc of "SQL Functions Returning Sets" in xfunc.sgml.

From: 日向充 <mitsuru(dot)hinata(dot)5432(at)gmail(dot)com>
To: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
Cc: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, Michael Paquier <michael(at)paquier(dot)xyz>, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: A minor bug in the doc of "SQL Functions Returning Sets" in xfunc.sgml.
Date: 2024-07-22 06:33:44
Message-ID: CAF-2iM8NcSDA9A0xwfYDuJH8H5DPkwDBsPp4ArwQWirq-eHthw@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Thu, Jul 18, 2024 at 9:05 PM Tom Lane
<tgl(at)sss(dot)pgh(dot)pa(dot)us> wrote:

> "David G. Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com> writes:
> > On Thu, Jul 18, 2024 at 7:10 PM Michael Paquier <michael(at)paquier(dot)xyz>
> wrote:
> >> 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.
>
> I'm with Michael here. Only in the tutorial do we expect there to be
> a continuing thread of commands that you can just copy-and-paste and
> expect to work. I do not think it's reasonable to extend that policy
> to the rest of the manual: in other places, there are too many
> distinct topics under consideration and too much reason to make
> localized changes.
>

Thank you Michael, David and Tom Lane for your replies.
I understand the policy in this document.

Mitsuru Hinata
NTT Open Source Software Center

2024年7月19日(金) 13:15 David G. Johnston <david(dot)g(dot)johnston(at)gmail(dot)com>:
>
> On Thu, Jul 18, 2024 at 9:05 PM Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> wrote:
>>
>> "David G. Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com> writes:
>> > On Thu, Jul 18, 2024 at 7:10 PM Michael Paquier <michael(at)paquier(dot)xyz> wrote:
>> >> 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.
>>
>> I'm with Michael here. Only in the tutorial do we expect there to be
>> a continuing thread of commands that you can just copy-and-paste and
>> expect to work. I do not think it's reasonable to extend that policy
>> to the rest of the manual: in other places, there are too many
>> distinct topics under consideration and too much reason to make
>> localized changes.
>>
>
> So much for leaving a place a little nicer when you leave than when you arrived...
>
> David J.
>

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message PG Doc comments form 2024-07-22 08:00:26 Undocumented := alternative in using option of raise statement
Previous Message shveta malik 2024-07-22 05:29:28 Re: Correction in doc of failover ready steps