From: Bruce Momjian <bruce@momjian.us>
To: ppkrauss@gmail.com
To: pgsql-docs@lists.postgresql.org
Subject: Re: need for "see also" section or similar thing at hub pages
Date: Wed, 5 Aug 2020 20:29:50 -0400
Message-ID: <20200806002950.GC29874@momjian.us> (raw)
In-Reply-To: <159655659222.654.5633935834473725951@wrigleys.postgresql.org>
References: <159655659222.654.5633935834473725951@wrigleys.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
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: bruce@momjian.us, ppkrauss@gmail.com, pgsql-docs@lists.postgresql.org
Subject: Re: need for "see also" section or similar thing at hub pages
In-Reply-To: <20200806002950.GC29874@momjian.us>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
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