Skip site navigation (1) Skip section navigation (2)

Re: Plug in docs

From: Simon Riggs <simon(at)2ndquadrant(dot)com>
To: "Joshua D(dot) Drake" <jd(at)commandprompt(dot)com>
Cc: Bruce Momjian <bruce(at)momjian(dot)us>, pgsql-docs(at)postgresql(dot)org
Subject: Re: Plug in docs
Date: 2007-12-16 17:40:06
Message-ID: 1197826806.12912.37.camel@ebony.site (view raw or flat)
Thread:
Lists: pgsql-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


In response to

Responses

pgsql-docs by date

Next:From: Tom LaneDate: 2007-12-16 17:59:52
Subject: Re: Plug in docs
Previous:From: Joshua D. DrakeDate: 2007-12-16 15:58:50
Subject: Re: Plug in docs

Privacy Policy | About PostgreSQL
Copyright © 1996-2014 The PostgreSQL Global Development Group