From: Simon Riggs <simon@2ndquadrant.com>
To: Joshua D. Drake <jd@commandprompt.com>
Cc: Bruce Momjian <bruce@momjian.us>
Cc: pgsql-docs@postgresql.org
Subject: Re: Plug in docs
Date: Sun, 16 Dec 2007 17:40:06 +0000
Message-ID: <1197826806.12912.37.camel@ebony.site> (raw)
In-Reply-To: <47654B3A.7030206@commandprompt.com>
References: <200712160812.lBG8C5x15519@momjian.us>
<47654B3A.7030206@commandprompt.com>
On Sun, 2007-12-16 at 07:58 -0800, Joshua D. Drake wrote:
> Bruce Momjian wrote:
> > Simon Riggs wrote:
> >> Looks like we need some docs on all these new plugin APIs we've
> >> introduced in this release.
> >>
> >> - PL/pgSQL hooks
> >> - planner hooks
> >> - join order hooks
> >
> > Do we normally document these?
I don't believe that there is a "normal" yet that applies for these.
> I think these are
> > documented-in-the-source-code type issues.
>
> If they are an API they need to be documented. Code is poor (even well
> documented code) substitute for good old fashioned docs.
Agreed.
Doesn't need to be War and Peace, just an overview.
--
Simon Riggs
2ndQuadrant http://www.2ndQuadrant.com
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: simon@2ndquadrant.com, jd@commandprompt.com, bruce@momjian.us
Subject: Re: Plug in docs
In-Reply-To: <1197826806.12912.37.camel@ebony.site>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
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