From bfbe9325ba80781a3f18f80267cf876cae2484dd Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Wed, 26 Feb 2025 12:31:15 -0600 Subject: [PATCH] You cannot have COMMENTs for functions which share a name with other objects The solution is to have a separate syntax for function comments. It is not worth the work at this time. --- doc/README | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/README b/doc/README index 4951679..c971c81 100644 --- a/doc/README +++ b/doc/README @@ -33,6 +33,15 @@ name of the repacement text is TABLENAME_summary or TABLENAME.ColumnName_summary. Usually, the documentation of the table or column begins with the replacement text. +Views and functions also have such *_summary replacement text. +Although functions are allowed to have the same name as views and +tables, the *_summary syntax has no way of distinguishing functions +from other objects. You may not have *_summary text for a both a +function and another object when both have the same name. + +All *_summary replacement text is used to supply the database with +comment text for PostgreSQL's COMMENT facility. + Validation rules involving individual columns are documented in the column's description. Rules involving multiple columns, or multiple tables, are documented in the table's description. When more than one -- 2.34.1