plpython docs should say 'plpy.Error' instead of ERROR

Lists: pgsql-docs
From: Marti Raudsepp <marti(at)juffo(dot)org>
To: pgsql-docs <pgsql-docs(at)postgresql(dot)org>
Subject: plpython docs should say 'plpy.Error' instead of ERROR
Date: 2010-11-09 10:21:54
Message-ID: AANLkTi=mkHMKtmzMg7OY9rC-TinYow4XAqtKT-DgX9aF@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-docs

Currently the PL/Python documentation claims that:
"raise plpy.ERROR(msg) and raise plpy.FATAL(msg) are equivalent to
calling plpy.error and plpy.fatal, respectively"

However, the actual names are Error and Fatal, not ERROR or FATAL
(Python is case-sensitive). Patch to fix documentation attached.

postgres=# CREATE OR REPLACE FUNCTION public.foo() RETURNS void
LANGUAGE plpythonu AS 'raise plpy.ERROR("foobar happened!")';
CREATE FUNCTION
postgres=# select foo();
ERROR: PL/Python: AttributeError: 'module' object has no attribute 'ERROR'
CONTEXT: PL/Python function "foo"

postgres=# CREATE OR REPLACE FUNCTION public.foo() RETURNS void
LANGUAGE plpythonu AS 'raise plpy.Error("foobar happened!")';
CREATE FUNCTION
postgres=# select foo();
ERROR: PL/Python: plpy.Error: foobar happened!
CONTEXT: PL/Python function "foo"

Regards,
Marti

Attachment Content-Type Size
0001-docs-plpython-has-plpy.Error-instead-of-plpy.ERROR.patch text/x-patch 1.1 KB
From: Alvaro Herrera <alvherre(at)commandprompt(dot)com>
To: Marti Raudsepp <marti(at)juffo(dot)org>
Cc: pgsql-docs <pgsql-docs(at)postgresql(dot)org>
Subject: Re: plpython docs should say 'plpy.Error' instead of ERROR
Date: 2010-11-09 14:34:15
Message-ID: 1289313237-sup-1899@alvh.no-ip.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-docs

Excerpts from Marti Raudsepp's message of mar nov 09 07:21:54 -0300 2010:
> Currently the PL/Python documentation claims that:
> "raise plpy.ERROR(msg) and raise plpy.FATAL(msg) are equivalent to
> calling plpy.error and plpy.fatal, respectively"
>
> However, the actual names are Error and Fatal, not ERROR or FATAL
> (Python is case-sensitive). Patch to fix documentation attached.

Thanks, pushed to 9.0 and HEAD.

--
Álvaro Herrera <alvherre(at)commandprompt(dot)com>
The PostgreSQL Company - Command Prompt, Inc.
PostgreSQL Replication, Consulting, Custom Development, 24x7 support