Re: </replaceable> in parentesis is not usual on DOCs

From: jian he <jian(dot)universality(at)gmail(dot)com>
To: Daniel Gustafsson <daniel(at)yesql(dot)se>
Cc: Marcos Pegoraro <marcos(at)f10(dot)com(dot)br>, PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: </replaceable> in parentesis is not usual on DOCs
Date: 2024-05-16 04:14:56
Message-ID: CACJufxFhaysmr0DrJSohKOXY_AntG3gzAFr1pZv7C0WMPLwQ3g@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Wed, May 15, 2024 at 8:34 PM Daniel Gustafsson <daniel(at)yesql(dot)se> wrote:
>
> > On 15 May 2024, at 14:04, Marcos Pegoraro <marcos(at)f10(dot)com(dot)br> wrote:
>
> > Why (context_item), (path_expression) and (json_path_name) are inside a parentheses ? This is not usual when explaining any 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 optional name (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.

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Hayato Kuroda (Fujitsu) 2024-05-16 05:02:55 RE: Slow catchup of 2PC (twophase) transactions on replica in LR
Previous Message Kashif Zeeshan 2024-05-16 04:11:04 Re: PostgreSQL 17 Beta 1 release announcement draft