Improve function header comment for create_singleton_array().

Mentioning the caller is neither future-proof nor an adequate substitute
for giving an API specification.  Per gripe from Neha Khatri, though
I changed the patch around some.

Discussion: https://postgr.es/m/CAFO0U+_fS5SRhzq6uPG+4fbERhoA9N2+nPrtvaC9mmeWivxbsA@mail.gmail.com
This commit is contained in:
Tom Lane 2017-05-01 15:31:41 -04:00
parent 92a43e4857
commit 54affb41e7
1 changed files with 4 additions and 1 deletions

View File

@ -455,7 +455,10 @@ array_cat(PG_FUNCTION_ARGS)
/*
* used by text_to_array() in varlena.c
* create_singleton_array - make a one-element array
*
* If desired, the caller can ask for it to be higher than one-dimensional.
* Caller's fcinfo must be passed in, as we use fn_extra for caching.
*/
ArrayType *
create_singleton_array(FunctionCallInfo fcinfo,