pg.ddx.io  pgsql-bugs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
Spurious curly bracket in "CREATE FUNCTION"/"CREATE PROCEDURE" doc
2+ messages / 2 participants
[nested] [flat]

Commits from this thread:
  2026-10-06 1a0039d003 3ded88be12 ae15292971 83764809ac a4c1c60db4 658100f85b 7358c30d38  Doc: remove stray right brace in TRANSFORM option syntax summaries.
* Spurious curly bracket in "CREATE FUNCTION"/"CREATE PROCEDURE" doc
@ 2026-10-05 07:48 Lele Gaifax <lele@metapensiero.it>
  2026-10-06 00:41 ` Re: Spurious curly bracket in "CREATE FUNCTION"/"CREATE PROCEDURE" doc Tom Lane <tgl@sss.pgh.pa.us>
  0 siblings, 1 reply; 2+ messages in thread

From: Lele Gaifax @ 2026-10-05 07:48 UTC (permalink / raw)
  To: pgsql-bugs@lists.postgresql.org

Hi all,

I think I spotted two minor glitches in the documentation for both
"CREATE FUNCTION" and "CREATE PROCEDURE" doc pages.

The detailed entry for the "TRANSFORM" option in their "Parameters"
section (not the "Synopsis" one), has a trailing "}" that I think it is
spurious. It currently shows

  TRANSFORM { FOR TYPE type_name } [, ... ] }

    Lists which transforms a call to the function should apply...

I can see the same "problem" (assuming it is not me misreading the
syntax) in all versions of the pages (that is, from v14 to "current"
version of PG) visible at https://www.postgresql.org/docs/.

If I am right, the following patch against current master would fix
the problem:

inline patch 1: doc/src/sgml/ref/create_function.sgml, doc/src/sgml/ref/create_procedure.sgml (+2/-2 lines) download inline-1.patchdiff --git a/doc/src/sgml/ref/create_function.sgml b/doc/src/sgml/ref/create_function.sgml index 91148af012d..8e7f4aa08b6 100644 --- a/doc/src/sgml/ref/create_function.sgml +++ b/doc/src/sgml/ref/create_function.sgml @@ -273,7 +273,7 @@ CREATE [ OR REPLACE ] FUNCTION </varlistentry> <varlistentry> - <term><literal>TRANSFORM { FOR TYPE <replaceable class="parameter">type_name</replaceable> } [, ... ] }</literal></term> + <term><literal>TRANSFORM { FOR TYPE <replaceable class="parameter">type_name</replaceable> } [, ... ]</literal></term> <listitem> <para> diff --git a/doc/src/sgml/ref/create_procedure.sgml b/doc/src/sgml/ref/create_procedure.sgml index 03a14c86845..2cda4876b59 100644 --- a/doc/src/sgml/ref/create_procedure.sgml +++ b/doc/src/sgml/ref/create_procedure.sgml @@ -177,7 +177,7 @@ CREATE [ OR REPLACE ] PROCEDURE </varlistentry> <varlistentry> - <term><literal>TRANSFORM { FOR TYPE <replaceable class="parameter">type_name</replaceable> } [, ... ] }</literal></term> + <term><literal>TRANSFORM { FOR TYPE <replaceable class="parameter">type_name</replaceable> } [, ... ]</literal></term> <listitem> <para>
All the best, bye, lele. -- nickname: Lele Gaifax | Seeing Emacs as an editor is like seeing a car real: Emanuele Gaifas | as a seating-accomodation. lele@metapensiero.it | -- Karl Voit ^ permalink raw reply [nested|flat] 2+ messages in thread

* Re: Spurious curly bracket in "CREATE FUNCTION"/"CREATE PROCEDURE" doc
  2026-10-05 07:48 Spurious curly bracket in "CREATE FUNCTION"/"CREATE PROCEDURE" doc Lele Gaifax <lele@metapensiero.it>
@ 2026-10-06 00:41 ` Tom Lane <tgl@sss.pgh.pa.us>
  0 siblings, 0 replies; 2+ messages in thread

From: Tom Lane @ 2026-10-06 00:41 UTC (permalink / raw)
  To: Lele Gaifax <lele@metapensiero.it>; +Cc: pgsql-bugs@lists.postgresql.org

Lele Gaifax <lele@metapensiero.it> writes:
> I think I spotted two minor glitches in the documentation for both
> "CREATE FUNCTION" and "CREATE PROCEDURE" doc pages.
> The detailed entry for the "TRANSFORM" option in their "Parameters"
> section (not the "Synopsis" one), has a trailing "}" that I think it is
> spurious. ...

Right you are, fix pushed.  Thanks for the report!

			regards, tom lane






^ permalink  raw  reply  [nested|flat] 2+ messages in thread


end of thread, other threads:[~2026-10-06 00:41 UTC | newest]

Thread overview: 2+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2026-10-05 07:48 Spurious curly bracket in "CREATE FUNCTION"/"CREATE PROCEDURE" doc Lele Gaifax <lele@metapensiero.it>
2026-10-06 00:41 ` Tom Lane <tgl@sss.pgh.pa.us>

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox