Re: substring synopsis section, third argument is optional doc didn't show that

From: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
To: jian he <jian(dot)universality(at)gmail(dot)com>
Cc: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: substring synopsis section, third argument is optional doc didn't show that
Date: 2025-02-17 23:05:59
Message-ID: CAKFQuwbiPN2pVd_xLp735ouoncOqtR3cHdX4QEpcfbq_=ho=CQ@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Tue, Jan 21, 2025 at 11:29 PM jian he <jian(dot)universality(at)gmail(dot)com>
wrote:

> in 9.7.2 do you think it's worthwhile changing it to

""
> As with SIMILAR TO, substring(string, pattern, escape-character)
> the specified pattern must match the entire data string, or else the
> function fails and returns null.
> ""
> ?
>
>
Making reference to any one of the three listed function signatures here
doesn't seem to provide value. If anything I'd write:

"As with SIMILAR TO, substring matches the specified pattern to the entire
data string, returning null otherwise."

I would avoid saying that the function fails in any situation that doesn't
produce an actual error. The transition of "match everything or returns
null" can be bike-shedded though.

David J.

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message David G. Johnston 2025-02-18 00:24:44 Re: Logical replication - initial data synchronization
Previous Message David G. Johnston 2025-02-17 22:48:06 Re: Improve examples: Provide the example which extend to the left of the range