public inbox for [email protected]
help / color / mirror / Atom feedCOMMENT page fixup
2+ messages / 2 participants
[nested] [flat]
* COMMENT page fixup
@ 2011-05-28 20:16 Josh Kupershmidt <[email protected]>
2011-06-02 21:18 ` Re: COMMENT page fixup Peter Eisentraut <[email protected]>
0 siblings, 1 reply; 2+ messages in thread
From: Josh Kupershmidt @ 2011-05-28 20:16 UTC (permalink / raw)
To: pgsql-docs
Hi all,
Is there any reason the Synopsis for the COMMENT ON:
http://developer.postgresql.org/pgdocs/postgres/sql-comment.html
is alphabetized except for TABLE and COLUMN? The examples at the
bottom of the page are properly alphabetized, though I noticed a few
object types are missing examples (those objects which only recently
supported COMMENT ON). Attached is a patch to fix both gripes.
Josh
Attachments:
[application/octet-stream] comment_synopsis.patch (3.0K, 2-comment_synopsis.patch)
download | inline diff:
diff --git a/doc/src/sgml/ref/comment.sgml b/doc/src/sgml/ref/comment.sgml
index 1cdc49f..eafc1b7 100644
--- a/doc/src/sgml/ref/comment.sgml
+++ b/doc/src/sgml/ref/comment.sgml
@@ -23,11 +23,10 @@ PostgreSQL documentation
<synopsis>
COMMENT ON
{
- TABLE <replaceable class="PARAMETER">object_name</replaceable> |
- COLUMN <replaceable class="PARAMETER">table_name</replaceable>.<replaceable class="PARAMETER">column_name</replaceable> |
AGGREGATE <replaceable class="PARAMETER">agg_name</replaceable> (<replaceable class="PARAMETER">agg_type</replaceable> [, ...] ) |
CAST (<replaceable>source_type</replaceable> AS <replaceable>target_type</replaceable>) |
COLLATION <replaceable class="PARAMETER">object_name</replaceable> |
+ COLUMN <replaceable class="PARAMETER">table_name</replaceable>.<replaceable class="PARAMETER">column_name</replaceable> |
CONSTRAINT <replaceable class="PARAMETER">constraint_name</replaceable> ON <replaceable class="PARAMETER">table_name</replaceable> |
CONVERSION <replaceable class="PARAMETER">object_name</replaceable> |
DATABASE <replaceable class="PARAMETER">object_name</replaceable> |
@@ -47,6 +46,7 @@ COMMENT ON
SCHEMA <replaceable class="PARAMETER">object_name</replaceable> |
SEQUENCE <replaceable class="PARAMETER">object_name</replaceable> |
SERVER <replaceable class="PARAMETER">object_name</replaceable> |
+ TABLE <replaceable class="PARAMETER">object_name</replaceable> |
TABLESPACE <replaceable class="PARAMETER">object_name</replaceable> |
TEXT SEARCH CONFIGURATION <replaceable class="PARAMETER">object_name</replaceable> |
TEXT SEARCH DICTIONARY <replaceable class="PARAMETER">object_name</replaceable> |
@@ -265,8 +265,11 @@ COMMENT ON CAST (text AS int4) IS 'Allow casts from text to int4';
COMMENT ON COLLATION "fr_CA" IS 'Canadian French';
COMMENT ON COLUMN my_table.my_column IS 'Employee ID number';
COMMENT ON CONVERSION my_conv IS 'Conversion to UTF8';
+COMMENT ON CONSTRAINT bar_col_cons ON bar IS 'Constrains column col';
COMMENT ON DATABASE my_database IS 'Development Database';
COMMENT ON DOMAIN my_domain IS 'Email Address Domain';
+COMMENT ON EXTENSION hstore IS 'implements the hstore data type';
+COMMENT ON FOREIGN DATA WRAPPER mywrapper IS 'my foreign data wrapper';
COMMENT ON FOREIGN TABLE my_foreign_table IS 'Employee Information in other database';
COMMENT ON FUNCTION my_function (timestamp) IS 'Returns Roman Numeral';
COMMENT ON INDEX my_index IS 'Enforces uniqueness on employee ID';
@@ -280,6 +283,7 @@ COMMENT ON ROLE my_role IS 'Administration group for finance tables';
COMMENT ON RULE my_rule ON my_table IS 'Logs updates of employee records';
COMMENT ON SCHEMA my_schema IS 'Departmental data';
COMMENT ON SEQUENCE my_sequence IS 'Used to generate primary keys';
+COMMENT ON SERVER myserver IS 'my foreign server';
COMMENT ON TABLE my_schema.my_table IS 'Employee Information';
COMMENT ON TABLESPACE my_tablespace IS 'Tablespace for indexes';
COMMENT ON TEXT SEARCH CONFIGURATION my_config IS 'Special word filtering';
^ permalink raw reply [nested|flat] 2+ messages in thread
* Re: COMMENT page fixup
2011-05-28 20:16 COMMENT page fixup Josh Kupershmidt <[email protected]>
@ 2011-06-02 21:18 ` Peter Eisentraut <[email protected]>
0 siblings, 0 replies; 2+ messages in thread
From: Peter Eisentraut @ 2011-06-02 21:18 UTC (permalink / raw)
To: Josh Kupershmidt <[email protected]>; +Cc: pgsql-docs
On lör, 2011-05-28 at 16:16 -0400, Josh Kupershmidt wrote:
> Is there any reason the Synopsis for the COMMENT ON:
> http://developer.postgresql.org/pgdocs/postgres/sql-comment.html
>
> is alphabetized except for TABLE and COLUMN? The examples at the
> bottom of the page are properly alphabetized, though I noticed a few
> object types are missing examples (those objects which only recently
> supported COMMENT ON). Attached is a patch to fix both gripes.
Committed.
^ permalink raw reply [nested|flat] 2+ messages in thread
end of thread, other threads:[~2011-06-02 21:18 UTC | newest]
Thread overview: 2+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2011-05-28 20:16 COMMENT page fixup Josh Kupershmidt <[email protected]>
2011-06-02 21:18 ` Peter Eisentraut <[email protected]>
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox