Re: Comments on all system objects

From: Fabien COELHO <coelho(at)cri(dot)ensmp(dot)fr>
To: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Cc: Christopher Kings-Lynne <chriskl(at)familyhealth(dot)com(dot)au>, PostgreSQL-development <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Comments on all system objects
Date: 2004-05-10 07:11:50
Message-ID: Pine.LNX.4.58.0405100902210.21629@sablons.cri.ensmp.fr
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers


> 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?

Maybe it would not be that bad if the comments could be derived
automatically from the sgml documentation? At least for comments that are
not provided directly from the initialization phase?

That may involve designing a new tag for the sgml. Something like
<shortdescr>... to specify the object name, its type and its description,
so that some filter could derive the appropriate "COMMENT ON".

I appreciate having something to read on a "\d+" in psql, without having
to turn to the online doc.

--
Fabien Coelho - coelho(at)cri(dot)ensmp(dot)fr

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Andrew Dunstan 2004-05-10 07:17:46 Re: mingw configure failure detection
Previous Message Bruce Momjian 2004-05-10 03:58:12 Re: Adding MERGE to the TODO list (resend with subject)