Re: need for "see also" section or similar thing at hub pages - Mailing list pgsql-docs

From Bruce Momjian
Subject Re: need for "see also" section or similar thing at hub pages
Date
Msg-id 20200806002950.GC29874@momjian.us
Whole thread Raw
In response to need for "see also" section or similar thing at hub pages  (PG Doc comments form <noreply@postgresql.org>)
Responses Re: need for "see also" section or similar thing at hub pages  ("David G. Johnston" <david.g.johnston@gmail.com>)
List 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@momjian.us>        https://momjian.us
  EnterpriseDB                             https://enterprisedb.com

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




pgsql-docs by date:

Previous
From: Bruce Momjian
Date:
Subject: Re: Procedures
Next
From: Michael Paquier
Date:
Subject: Re: Typo in the Section "3.6. Inheritance"