From: | Amit Langote <amitlan(at)postgresql(dot)org> |
---|---|
To: | pgsql-committers(at)lists(dot)postgresql(dot)org |
Subject: | pgsql: SQL/JSON: Various improvements to SQL/JSON query function docs |
Date: | 2024-07-09 07:18:43 |
Message-ID: | E1sR57b-000xXI-3s@gemulon.postgresql.org |
Views: | Raw Message | Whole Thread | Download mbox | Resend email |
Thread: | |
Lists: | pgsql-committers |
SQL/JSON: Various improvements to SQL/JSON query function docs
1. Remove the keyword SELECT from the examples to be consistent
with the examples of other JSON-related functions listed on the
same page.
2. Add <synopsis> tags around the functions' syntax definition
3. Capitalize function names in the syntax synopsis and the examples
4. Use <itemizedlist> lists for dividing the descriptions of
individual functions into bullet points
5. Significantly rewrite the description of wrapper clauses of
JSON_QUERY
6. Significantly rewrite the descriptions of ON ERROR / EMPTY
clauses of JSON_QUERY() and JSON_VALUE() functions
7. Add a note about how JSON_VALUE() and JSON_QUERY() differ when
returning a JSON null result
8. Move the description of the PASSING clause from the descriptions
of individual functions into the top paragraph
And other miscellaneous text improvements, typo fixes.
Suggested-by: Thom Brown <thom(at)linux(dot)com>
Suggested-by: David G. Johnston <david(dot)g(dot)johnston(at)gmail(dot)com>
Reviewed-by: Jian He <jian(dot)universality(at)gmail(dot)com>
Reviewed-by: Erik Rijkers <er(at)xs4all(dot)nl>
Discussion: https://postgr.es/m/CAA-aLv7Dfy9BMrhUZ1skcg=OdqysWKzObS7XiDXdotJNF0E44Q@mail.gmail.com
Discussion: https://postgr.es/m/CAKFQuwZNxNHuPk44zDF7z8qZec1Aof10aA9tWvBU5CMhEKEd8A@mail.gmail.com
Branch
------
REL_17_STABLE
Details
-------
https://git.postgresql.org/pg/commitdiff/ce416fadb4b694ba32e228b8296d8f10f39640c0
Modified Files
--------------
doc/src/sgml/func.sgml | 225 ++++++++++++++++++++++++++++++++-----------------
1 file changed, 147 insertions(+), 78 deletions(-)
From | Date | Subject | |
---|---|---|---|
Next Message | Amit Langote | 2024-07-09 07:18:56 | pgsql: SQL/JSON: Various improvements to SQL/JSON query function docs |
Previous Message | Amit Kapila | 2024-07-09 03:45:49 | pgsql: To improve the code, move the error check in logical_read_xlog_p |