Add argument name to CREATE FUNCTION documentation

Dennis Bjorklund <db@zigo.dhs.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

On Thu, 24 Jun 2004, Tom Lane wrote:

1. We usually leave spaces around brackets in syntax definitions, so
I'd go for "... [ argname ] ..." not "... [argname] ..."

I saw both in that very rule (later there is an [EXTERNAL]) so I guessed
that one use what looks best at different places. But consistency is good.

--
/Dennis Bj�rklund

Dennis Bjorklund <db@zigo.dhs.org> writes:

On Thu, 24 Jun 2004, Tom Lane wrote:

1. We usually leave spaces around brackets in syntax definitions, so
I'd go for "... [ argname ] ..." not "... [argname] ..."

I saw both in that very rule (later there is an [EXTERNAL]) so I guessed
that one use what looks best at different places. But consistency is good.

Feel free to fix that one while you're at it ... but yes, this is mostly
a visual thing. Do what looks good.

regards, tom lane