public inbox for [email protected]  

help / color / mirror / Atom feed
From: Justin Dearing <[email protected]>
To: [email protected]
Subject: Some doc suggestions
Date: Fri, 24 Jun 2016 02:37:29 +0000
Message-ID: <CABsCM1OLA=Z1C4y5_qzBdYPs-_XJh2S3Q=NMH=SZvi4c+ioy3g@mail.gmail.com> (raw)
List-Unsubscribe: <mailto:[email protected]?body=unsub%20pgsql-docs>

Switched jobs recently and returning to postgres after a long hiatus. The
docs are great, but I noticed a few things  that could be improved in the
area of catalot documentations.


   1. The CREATE/ALTER/DROP doc pages should have a link to the
   corresponding pg_catalog and INFORMATION_schema tables and views for that
   object type. The
   2. pg_catalog docs should have a link to their corresponding
   information_schema table or view and visa versa.
   3. Perhaps this page (and its analogs)
   https://www.postgresql.org/docs/9.1/static/catalogs.html should have a
   1-3 word description of each catalog. Some are unintuitive. For example it
   took awhile to figure out pg_attribute was the list of columns.
   4. OID columns should have a note saying something to the effect of "to
   get the text name of this simply use atttypid::REGTYPE"
   5. I discovered that pg_catalog.name is a built in type today, but its
   not listed as a built in type. I've yet to find it in the docs. It should
   either be listed in the built in types, or the list of built in types
   should link to the list of "other built in types" whereever they are.

If any of those suggestions are ameanable where are the docs for
contributing to the docs?

Regards,

Justin Dearing


view thread (3+ messages)  latest in thread

reply
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: [email protected]
  Cc: [email protected]
  Subject: Re: Some doc suggestions
  In-Reply-To: <CABsCM1OLA=Z1C4y5_qzBdYPs-_XJh2S3Q=NMH=SZvi4c+ioy3g@mail.gmail.com>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox