Re: Comments on all system objects

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Christopher Kings-Lynne <chriskl(at)familyhealth(dot)com(dot)au>
Cc: PostgreSQL-development <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Comments on all system objects
Date: 2004-05-08 16:19:55
Message-ID: 26102.1084033195@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Christopher Kings-Lynne <chriskl(at)familyhealth(dot)com(dot)au> writes:
> Is there any reason I shouldn't submit a patch that makes it so that we
> have comments on 100% of the catalog objects?

Bulk? Redundancy with the SGML documentation?

There are already more than enough places to have to edit documentation
when we change/add a column in a system catalog. I don't see the value
of adding another, especially not one that's constrained to one line.
And what will comments on, say, system indexes contribute really?

I think we are fairly close to having some kind of comment on nearly all
the built-in functions and operators (though far too many of those
comments are useless boilerplate that we could just as well do without).
Cleaning up any omissions in that area doesn't seem like a bad project.
But I question the value of extending the policy to other sorts of
objects.

regards, tom lane

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Peter Eisentraut 2004-05-08 16:28:55 Re: Comments on all system objects
Previous Message Tom Lane 2004-05-08 15:42:02 Re: email built in type