Re: Add argument name to CREATE FUNCTION documentation - Mailing list pgsql-patches

From Tom Lane
Subject Re: Add argument name to CREATE FUNCTION documentation
Date
Msg-id 586.1088132253@sss.pgh.pa.us
Whole thread Raw
In response to Add argument name to CREATE FUNCTION documentation  (Dennis Bjorklund <db@zigo.dhs.org>)
Responses Re: Add argument name to CREATE FUNCTION documentation  (Dennis Bjorklund <db@zigo.dhs.org>)
List pgsql-patches
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

pgsql-patches by date:

Previous
From: Alvaro Herrera
Date:
Subject: Re: nested xacts and phantom Xids
Next
From: Dennis Bjorklund
Date:
Subject: Re: Add argument name to CREATE FUNCTION documentation