pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedneed for "see also" section or similar thing at hub pages
3+ messages / 2 participants
[nested] [flat]
* need for "see also" section or similar thing at hub pages
@ 2020-08-04 15:56 PG Doc comments form <noreply@postgresql.org>
0 siblings, 1 reply; 3+ messages in thread
From: PG Doc comments form @ 2020-08-04 15:56 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org; +Cc: ppkrauss@gmail.com
The following documentation comment has been logged on the website:
Page: https://www.postgresql.org/docs/12/functions-textsearch.html
Description:
A suggestion. This page, "functions-textsearch", is fine, and the best
place to explain functions like array_to_tsvector() and jsonb_to_tsvector().
The suggestion is just to cite these native functions in the Guide's "hub
page" of respective prefixes...
Ideal, for Guide reader, is to be informed about the existence of all array
functions in the Array's hub page,
https://www.postgresql.org/docs/current/functions-array.html , and all JSON
functions in the JSON's hub page
https://www.postgresql.org/docs/current/functions-json.html
Simple citation anywhere in the hub page, or a simple "See also" section to
list the non-explained functions that can be also classifyed as valid
function for that hub page.
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: need for "see also" section or similar thing at hub pages
@ 2020-08-06 00:29 Bruce Momjian <bruce@momjian.us>
parent: PG Doc comments form <noreply@postgresql.org>
0 siblings, 0 replies; 3+ messages in thread
From: Bruce Momjian @ 2020-08-06 00:29 UTC (permalink / raw)
To: ppkrauss@gmail.com; pgsql-docs@lists.postgresql.org
On Tue, Aug 4, 2020 at 03:56:32PM +0000, PG Doc comments form wrote:
> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/12/functions-textsearch.html
> Description:
>
> A suggestion. This page, "functions-textsearch", is fine, and the best
> place to explain functions like array_to_tsvector() and jsonb_to_tsvector().
> The suggestion is just to cite these native functions in the Guide's "hub
> page" of respective prefixes...
>
> Ideal, for Guide reader, is to be informed about the existence of all array
> functions in the Array's hub page,
> https://www.postgresql.org/docs/current/functions-array.html , and all JSON
> functions in the JSON's hub page
> https://www.postgresql.org/docs/current/functions-json.html
>
> Simple citation anywhere in the hub page, or a simple "See also" section to
> list the non-explained functions that can be also classifyed as valid
> function for that hub page.
Uh, I am not sure it helps to mention that there are text
search-specific functions in the generic sections.
--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EnterpriseDB https://enterprisedb.com
The usefulness of a cup is in its emptiness, Bruce Lee
^ permalink raw reply [nested|flat] 3+ messages in thread
end of thread, other threads:[~2020-08-06 00:29 UTC | newest]
Thread overview: 3+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2020-08-04 15:56 need for "see also" section or similar thing at hub pages PG Doc comments form <noreply@postgresql.org>
2020-08-06 00:29 ` Bruce Momjian <bruce@momjian.us>
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox