Small doc tweak for array/string functions

Started by Ian Lawrence Barwickover 7 years ago2 messageshackers
Jump to latest
#1Ian Lawrence Barwick
barwick@gmail.com

Hi

On these pages:

- https://www.postgresql.org/docs/current/functions-array.html
- https://www.postgresql.org/docs/current/functions-string.html

we point out via "See also" the existence of aggregate array and string
functions, but I think it would be useful to also mention the existence
of string-related array functions and array-related string (regexp) functions
respectively.

(Background: due to brain fade I was looking on the array functions page
for the array-related function whose name was escaping me which does something
with regexes to make an array, and was puzzled to find no reference on that page).

Regards

Ian Barwick

--
Ian Barwick http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Training & Services

Attachments:

doc-array-string-funcs-see-also-v1.patchtext/x-patch; name=doc-array-string-funcs-see-also-v1.patchDownload+8-8
#2Tom Lane
tgl@sss.pgh.pa.us
In reply to: Ian Lawrence Barwick (#1)
Re: Small doc tweak for array/string functions

Ian Barwick <ian.barwick@2ndquadrant.com> writes:

On these pages:
- https://www.postgresql.org/docs/current/functions-array.html
- https://www.postgresql.org/docs/current/functions-string.html
we point out via "See also" the existence of aggregate array and string
functions, but I think it would be useful to also mention the existence
of string-related array functions and array-related string (regexp) functions
respectively.

Hmm. The existing cross-references there feel a bit ad-hoc to me already,
and the proposed additions even more so. Surely we don't want to conclude
that every function that takes or returns an array needs to be cited on
the functions-array page; and that idea would be even sillier if applied
to strings. How can we define a less spur-of-the-moment approach to
deciding what to list?

The patch as shown might be just fine, but I'd like to have some rationale
for which things we're listing or not listing.

regards, tom lane