Re: Add argument name to CREATE FUNCTION documentation

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Dennis Bjorklund <db(at)zigo(dot)dhs(dot)org>
Cc: pgsql-patches(at)postgresql(dot)org
Subject: Re: Add argument name to CREATE FUNCTION documentation
Date: 2004-06-25 02:57:33
Message-ID: 586.1088132253@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-patches

Dennis Bjorklund <db(at)zigo(dot)dhs(dot)org> writes:
> It's not much text, but someone who speaks english might want to look at
> it.

Two trivial comments:

1. We usually leave spaces around brackets in syntax definitions, so
I'd go for "... [ argname ] ..." not "... [argname] ..."
Also, check that the resulting format looks good in psql's \h output.
You might need to fool with spacing/line breaks to make it look good.

2. The grammar in your description is a bit off; it would read better as

The name of an argument. Some languages (currently only PL/pgSQL) let
you use the name in the function body. For other languages the
argument name is just extra documentation.

Otherwise, apply away.

regards, tom lane

In response to

Responses

Browse pgsql-patches by date

  From Date Subject
Next Message Dennis Bjorklund 2004-06-25 05:33:49 Re: Add argument name to CREATE FUNCTION documentation
Previous Message Alvaro Herrera 2004-06-24 23:53:27 Re: nested xacts and phantom Xids