aboutsummaryrefslogtreecommitdiff
path: root/src/backend/utils/adt/array_userfuncs.c
diff options
context:
space:
mode:
authorTom Lane <tgl@sss.pgh.pa.us>2017-05-01 15:31:41 -0400
committerTom Lane <tgl@sss.pgh.pa.us>2017-05-01 15:31:41 -0400
commit54affb41e79cf4bec00bb5e00eb12a1715b9e278 (patch)
treed62321e1dec4e09ca680b869bf56a10cf3fc3c27 /src/backend/utils/adt/array_userfuncs.c
parent92a43e4857d9682b93c9f755f453cc8fd7c66c81 (diff)
downloadpostgresql-54affb41e79cf4bec00bb5e00eb12a1715b9e278.tar.gz
postgresql-54affb41e79cf4bec00bb5e00eb12a1715b9e278.zip
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
Diffstat (limited to 'src/backend/utils/adt/array_userfuncs.c')
-rw-r--r--src/backend/utils/adt/array_userfuncs.c5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/backend/utils/adt/array_userfuncs.c b/src/backend/utils/adt/array_userfuncs.c
index e6c1f58ae08..8da3e0ac5b8 100644
--- a/src/backend/utils/adt/array_userfuncs.c
+++ b/src/backend/utils/adt/array_userfuncs.c
@@ -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,