Re: comments in argument list of plpgsql get stripped?

From: Ralph Graulich <maillist(at)shauny(dot)de>
To: rod(at)iol(dot)ie
Cc: pgsql-general(at)postgresql(dot)org
Subject: Re: comments in argument list of plpgsql get stripped?
Date: 2012-01-20 18:46:04
Message-ID: 5A8BAF9B-DFEC-4539-9FA2-28F7642BAECB@shauny.de
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-general

Hello Ray,

> You could use COMMENT ON instead:
>
> COMMENT ON function func_test(text, text)
> IS '....loads of documentation here....';
>
> Would this do the job?

Thank you for your input.

I know about the COMMENT ON function, as I use it for all other purposes, like documenting columns and other database objects. -

Within the function I can also put unlimited amount of documentation in the body of the plpgsql function to document the innards. This kind of comments get stored without problems.

But in order to have the documentation where it belongs to, it would be better to put the documentation for the argument list within the argument list, each comment to its argument. Let's assume you have 30 rather complex arguments or more you'll probably see my point - which might not be obvious in my simplified example.

Best regards,
Ralph

In response to

Browse pgsql-general by date

  From Date Subject
Next Message Matt Dew 2012-01-20 18:47:31 Re: indexes no longer used after shutdown during reindexing
Previous Message David Johnston 2012-01-20 18:44:05 Re: Immutable function with bind value