Re: adding a TOC to the psql reference page

From: grg bnc <grgbnc(at)gmail(dot)com>
To: pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: adding a TOC to the psql reference page
Date: 2020-04-30 23:04:51
Message-ID: CAN+Z=3a4VYgDAwDBVKW68AOzY_XSgVzCtm_6-022yCNXxNpx9w@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

For SQL commands that are:

- heavily used, and

- structurally involved

i'd say yes (`CREATE TABLE` comes to mind); otherwise, don't bother.

The above selection criteria are subjective, so consensus should be
gathered.

On Fri, May 1, 2020 at 12:16 AM Bruce Momjian <bruce(at)momjian(dot)us> wrote:

> On Thu, Apr 30, 2020 at 08:48:09PM +0000, PG Doc comments form wrote:
> > The following documentation comment has been logged on the website:
> >
> > Page: https://www.postgresql.org/docs/12/app-psql.html
> > Description:
> >
> > Since https://www.postgresql.org/docs/current/app-psql.html is quite
> long,
> > it would be nice to add a detailed table of contents at its beginning, in
> > order to:
> >
> > - allow for easier browsing
> >
> > - allow to reference individual psql options, meta-commands, variables,
> > prompts and environment variables by using their respective id attribute
>
> Yes, I can see the value in that, but I don't think we do that for any
> other SQL comments. Would doing it just for psql make sense?
>
> --
> Bruce Momjian <bruce(at)momjian(dot)us> https://momjian.us
> EnterpriseDB https://enterprisedb.com
>
> + As you are, so once was I. As I am, so you will be. +
> + Ancient Roman grave inscription +
>

--
All work and no play makes George go astray.

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Fujii Masao 2020-05-01 03:29:09 Re: Roles for pg_basebackup
Previous Message David G. Johnston 2020-04-30 22:26:32 Re: adding a TOC to the psql reference page