Re: Plug in docs

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