Thread: Missing doc for operator args in alter extension

Missing doc for operator args in alter extension

From
Daniele Varrazzo
Date:
Hello,

the documentation for ALTER EXTENSION is missing the description for
the arguments of the form ADD OPERATOR name (left_type, right_type).

Albeit it's pretty obvious what they are, it is not so obvious what to
do for unary operators (i.e. replace the type on the missing side with
NONE).

Patch to fix the doc attached.

-- Daniele

Attachment

Re: Missing doc for operator args in alter extension

From
Robert Haas
Date:
On Mon, Apr 4, 2011 at 9:10 PM, Daniele Varrazzo
<daniele.varrazzo@gmail.com> wrote:
> Hello,
>
> the documentation for ALTER EXTENSION is missing the description for
> the arguments of the form ADD OPERATOR name (left_type, right_type).
>
> Albeit it's pretty obvious what they are, it is not so obvious what to
> do for unary operators (i.e. replace the type on the missing side with
> NONE).
>
> Patch to fix the doc attached.

I think we might want to make the synopsis, as well as the description
of left_arg and right_arg, match what's on the DROP OPERATOR page.

Thoughts?

--
Robert Haas
EnterpriseDB: http://www.enterprisedb.com
The Enterprise PostgreSQL Company

Re: Missing doc for operator args in alter extension

From
Tom Lane
Date:
Robert Haas <robertmhaas@gmail.com> writes:
> On Mon, Apr 4, 2011 at 9:10 PM, Daniele Varrazzo
> <daniele.varrazzo@gmail.com> wrote:
>> the documentation for ALTER EXTENSION is missing the description for
>> the arguments of the form ADD OPERATOR name (left_type, right_type).

> I think we might want to make the synopsis, as well as the description
> of left_arg and right_arg, match what's on the DROP OPERATOR page.

I think I borrowed that text from the COMMENT page.  Should probably
look at that too.

            regards, tom lane

Re: Missing doc for operator args in alter extension

From
Robert Haas
Date:
On Thu, Apr 7, 2011 at 9:49 PM, Tom Lane <tgl@sss.pgh.pa.us> wrote:
> Robert Haas <robertmhaas@gmail.com> writes:
>> On Mon, Apr 4, 2011 at 9:10 PM, Daniele Varrazzo
>> <daniele.varrazzo@gmail.com> wrote:
>>> the documentation for ALTER EXTENSION is missing the description for
>>> the arguments of the form ADD OPERATOR name (left_type, right_type).
>
>> I think we might want to make the synopsis, as well as the description
>> of left_arg and right_arg, match what's on the DROP OPERATOR page.
>
> I think I borrowed that text from the COMMENT page.  Should probably
> look at that too.

Looks like you just failed to borrow quite enough.  Additional
borrowing committed.

--
Robert Haas
EnterpriseDB: http://www.enterprisedb.com
The Enterprise PostgreSQL Company