Re: need for "see also" section or similar thing at hub pages

From: Bruce Momjian <bruce(at)momjian(dot)us>
To: ppkrauss(at)gmail(dot)com, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: need for "see also" section or similar thing at hub pages
Date: 2020-08-06 00:29:50
Message-ID: 20200806002950.GC29874@momjian.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

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(at)momjian(dot)us> https://momjian.us
EnterpriseDB https://enterprisedb.com

The usefulness of a cup is in its emptiness, Bruce Lee

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Michael Paquier 2020-08-06 05:41:19 Re: Typo in the Section "3.6. Inheritance"
Previous Message Bruce Momjian 2020-08-06 00:17:58 Re: Procedures