Re: in parentesis is not usual on DOCs - Mailing list pgsql-hackers

From jian he
Subject Re: in parentesis is not usual on DOCs
Date
Msg-id CACJufxFhaysmr0DrJSohKOXY_AntG3gzAFr1pZv7C0WMPLwQ3g@mail.gmail.com
Whole thread Raw
In response to Re: in parentesis is not usual on DOCs  (Daniel Gustafsson <daniel@yesql.se>)
Responses Re: in parentesis is not usual on DOCs
List pgsql-hackers
On Wed, May 15, 2024 at 8:34 PM Daniel Gustafsson <daniel@yesql.se> wrote:
>
> > On 15 May 2024, at 14:04, Marcos Pegoraro <marcos@f10.com.br> wrote:
>
> > Why (context_item), (path_expression) and (json_path_name) are inside a parentheses ? This is not usual when
explainingany other feature. 
>
> Agreed, that's inconsisent with how for example json_table_column is documented
> in the next list item under COLUMNS.  Unless objected to I will remove these
> parenthesis.
>

>>  The input data to query (context_item), the JSON path expression defining the query (path_expression) with an
optionalname (json_path_name) 

i think the parentheses is for explaining that
context_item refers "The input data to query";
path_expression refers "the JSON path expression defining the query";
json_path_name refers to "an optional name";



removing parentheses means we need to rephrase this sentence?
So I come up with the following rephrase:

The context_item specifies the input data to query, the
path_expression is a JSON path expression defining the query,
json_path_name is an optional name for the path_expression. The
optional PASSING clause can provide data values to the
path_expression.



pgsql-hackers by date:

Previous
From: Kashif Zeeshan
Date:
Subject: Re: PostgreSQL 17 Beta 1 release announcement draft
Next
From: "Hayato Kuroda (Fujitsu)"
Date:
Subject: RE: Slow catchup of 2PC (twophase) transactions on replica in LR