Re: in parentesis is not usual on DOCs

2024-05-22 Thread jian he 
On Wed, May 22, 2024 at 7:14 PM Peter Eisentraut  wrote:
>
> On 20.05.24 02:00, jian he wrote:
> >> 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.
> >
> > Based on this, write a simple patch.
>
> Your patch kind of messes up the indentation of the text you are
> changing.  Please check that.

please check attached.
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 17c44bc3..485f1822 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -18956,10 +18956,10 @@ where json_table_column is:
 
 
 
- The input data to query (context_item),
- the JSON path expression defining the query (path_expression)
- with an optional name (json_path_name), and an
- optional PASSING clause, which can provide data values
+ 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.  The result of the input
  data evaluation using the aforementioned elements is called the
  row pattern, which is used as the source for row

Re: in parentesis is not usual on DOCs

2024-05-22 Thread Peter Eisentraut 

On 20.05.24 02:00, jian he wrote:

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.


Based on this, write a simple patch.


Your patch kind of messes up the indentation of the text you are 
changing.  Please check that.

Re: in parentesis is not usual on DOCs

2024-05-19 Thread jian he 
On Thu, May 16, 2024 at 12:14 PM jian he  wrote:
>
> On Wed, May 15, 2024 at 8:34 PM Daniel Gustafsson  wrote:
> >
> > > On 15 May 2024, at 14:04, Marcos Pegoraro  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.

Based on this, write a simple patch.
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 17c44bc3..f9047a8e 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -18956,10 +18956,10 @@ where json_table_column is:
 
 
 
- The input data to query (context_item),
- the JSON path expression defining the query (path_expression)
- with an optional name (json_path_name), and an
- optional PASSING clause, which can provide data values
+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.  The result of the input
  data evaluation using the aforementioned elements is called the
  row pattern, which is used as the source for row

Re: in parentesis is not usual on DOCs

2024-05-15 Thread jian he 
On Wed, May 15, 2024 at 8:34 PM Daniel Gustafsson  wrote:
>
> > On 15 May 2024, at 14:04, Marcos Pegoraro  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.

Re: in parentesis is not usual on DOCs

2024-05-15 Thread Daniel Gustafsson 
> On 15 May 2024, at 14:04, Marcos Pegoraro  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.

--
Daniel Gustafsson

in parentesis is not usual on DOCs

2024-05-15 Thread Marcos Pegoraro 
This page has 3 items that are between parentheses, there is an explanation
why they are used this way ?

https://www.postgresql.org/docs/devel/functions-json.html#FUNCTIONS-SQLJSON-TABLE


Each syntax element is described below in more detail.
*context_item*, *path_expression* [ AS *json_path_name* ] [ PASSING {
*value* AS *varname* } [, ...]]

The input data to query (*context_item*), the JSON path expression defining
the query (*path_expression*) with an optional name (*json_path_name*), and
an optional PASSING clause, which can provide data

Why (*context_item*), (*path_expression*) and (*json_path_name*) are inside
a parentheses ? This is not usual when explaining any other feature.

regards
Marcos