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

jian he <jian.universality@gmail.com>

From: jian he <jian.universality@gmail.com>
To: Daniel Gustafsson <daniel@yesql.se>
Cc: Marcos Pegoraro <marcos@f10.com.br>, PostgreSQL Hackers <pgsql-hackers@lists.postgresql.org>
Date: 2024-05-16T04:14:56Z
Lists: 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 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.



Commits

  1. SQL/JSON: Fix a paragraph in JSON_TABLE documentation