public inbox for [email protected]  
help / color / mirror / Atom feed
Missing doc for operator args in alter extension
4+ messages / 3 participants
[nested] [flat]

* Missing doc for operator args in alter extension
@ 2011-04-05 01:10  Daniele Varrazzo <[email protected]>
  0 siblings, 1 reply; 4+ messages in thread

From: Daniele Varrazzo @ 2011-04-05 01:10 UTC (permalink / raw)
  To: pgsql-docs

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


Attachments:

  [text/x-patch] alter_extension_operator_args.patch (738B, 2-alter_extension_operator_args.patch)
  download | inline diff:
--- doc/src/sgml/ref/alter_extension.sgml.bak	2011-04-05 01:48:24.013675393 +0100
+++ doc/src/sgml/ref/alter_extension.sgml	2011-04-05 01:55:09.485454466 +0100
@@ -218,6 +218,18 @@
     </varlistentry>
 
     <varlistentry>
+     <term><replaceable class="parameter">left_type</replaceable></term>
+     <term><replaceable class="parameter">right_type</replaceable></term>
+     <listitem>
+      <para>
+       The data types of the operator's left and right operands.
+       If the operator is unary, the missing argument must be replaced
+       by <literal>NONE</>.
+      </para>
+     </listitem>
+    </varlistentry>
+
+    <varlistentry>
      <term><replaceable class="parameter">argname</replaceable></term>
 
      <listitem>


^ permalink  raw  reply  [nested|flat] 4+ messages in thread

* Re: Missing doc for operator args in alter extension
@ 2011-04-05 17:14  Robert Haas <[email protected]>
  parent: Daniele Varrazzo <[email protected]>
  0 siblings, 1 reply; 4+ messages in thread

From: Robert Haas @ 2011-04-05 17:14 UTC (permalink / raw)
  To: Daniele Varrazzo <[email protected]>; +Cc: pgsql-docs

On Mon, Apr 4, 2011 at 9:10 PM, Daniele Varrazzo
<[email protected]> 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



^ permalink  raw  reply  [nested|flat] 4+ messages in thread

* Re: Missing doc for operator args in alter extension
@ 2011-04-08 01:49  Tom Lane <[email protected]>
  parent: Robert Haas <[email protected]>
  0 siblings, 1 reply; 4+ messages in thread

From: Tom Lane @ 2011-04-08 01:49 UTC (permalink / raw)
  To: Robert Haas <[email protected]>; +Cc: Daniele Varrazzo <[email protected]>; pgsql-docs

Robert Haas <[email protected]> writes:
> On Mon, Apr 4, 2011 at 9:10 PM, Daniele Varrazzo
> <[email protected]> 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



^ permalink  raw  reply  [nested|flat] 4+ messages in thread

* Re: Missing doc for operator args in alter extension
@ 2011-06-13 14:25  Robert Haas <[email protected]>
  parent: Tom Lane <[email protected]>
  0 siblings, 0 replies; 4+ messages in thread

From: Robert Haas @ 2011-06-13 14:25 UTC (permalink / raw)
  To: Tom Lane <[email protected]>; +Cc: Daniele Varrazzo <[email protected]>; pgsql-docs

On Thu, Apr 7, 2011 at 9:49 PM, Tom Lane <[email protected]> wrote:
> Robert Haas <[email protected]> writes:
>> On Mon, Apr 4, 2011 at 9:10 PM, Daniele Varrazzo
>> <[email protected]> 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




^ permalink  raw  reply  [nested|flat] 4+ messages in thread


end of thread, other threads:[~2011-06-13 14:25 UTC | newest]

Thread overview: 4+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2011-04-05 01:10 Missing doc for operator args in alter extension Daniele Varrazzo <[email protected]>
2011-04-05 17:14 ` Robert Haas <[email protected]>
2011-04-08 01:49   ` Tom Lane <[email protected]>
2011-06-13 14:25     ` Robert Haas <[email protected]>

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox