Re: ECPG Documentation Improvement

From: Heikki Linnakangas <heikki(dot)linnakangas(at)enterprisedb(dot)com>
To: Satoshi Nagayasu <satoshi(dot)nagayasu(at)gmail(dot)com>
Cc: pgsql-interfaces(at)postgresql(dot)org, pgsql-docs(at)postgresql(dot)org, Bruce Momjian <bruce(at)momjian(dot)us>, Michael Meskes <meskes(at)postgresql(dot)org>
Subject: Re: ECPG Documentation Improvement
Date: 2010-06-18 15:56:37
Message-ID: 4C1B9735.2040505@enterprisedb.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-interfaces

On 17/06/10 12:07, Satoshi Nagayasu wrote:
> I think it could be useful for the ECPG application developers,
> similar to the SQL reference section in the official manual.
>
> ecpgdocs @ GoogleCode (I'm working here.)
> http://code.google.com/p/ecpgdocs/
>
> ecpgdocs downloads (You can find the current document.)
> http://code.google.com/p/ecpgdocs/downloads/list?deleted=1&ts=1276763948
>
> However, I'm not familiar with ECPG details or internals,
> so here is one asking, I hope someone to review my documents
> and give some feedback to me.
>
> Feedbacks which I'm expecting are:
>
> - Is this document useful?
> - Missing directives.
> - Missing or wrong synopsis.
> - More appropriate descriptions on parameters or examples.
> - How to contribute this to the official manual.
> - Correcting English. (sorry for my poor English.)
> - etc...
>
> Honestly, I'm not familiar with the documentation acceptance/review process,
> so any advice and/or comments are welcome.

A reference of all the directives seems useful, but it seems at least
partially redundant with what's there already. WHENEVER for example is
quite well documented at
http://www.postgresql.org/docs/current/interactive/ecpg-errors.html already.

--
Heikki Linnakangas
EnterpriseDB http://www.enterprisedb.com

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message satoshi.nagayasu 2010-06-19 01:01:05 Re: ECPG Documentation Improvement
Previous Message Michael Meskes 2010-06-18 09:40:08 Re: ECPG Documentation Improvement

Browse pgsql-interfaces by date

  From Date Subject
Next Message satoshi.nagayasu 2010-06-19 01:01:05 Re: ECPG Documentation Improvement
Previous Message Michael Meskes 2010-06-18 09:40:08 Re: ECPG Documentation Improvement