MIME-Version: 1.0
References: 
 <CABsCM1OLA=Z1C4y5_qzBdYPs-_XJh2S3Q=NMH=SZvi4c+ioy3g@mail.gmail.com>
In-Reply-To: 
 <CABsCM1OLA=Z1C4y5_qzBdYPs-_XJh2S3Q=NMH=SZvi4c+ioy3g@mail.gmail.com>
From: Justin Dearing <zippy1981@gmail.com>
Date: Fri, 24 Jun 2016 02:42:16 +0000
Message-ID: 
 <CABsCM1PmBR5bNE_4NJS5SGnWwGXHQRDgheHXRp-VCT+s9PtmfA@mail.gmail.com>
Subject: Re: Some doc suggestions
To: pgsql-docs@postgresql.org
Content-Type: multipart/alternative; boundary=001a113efaaef29df60535fd1e6a
Precedence: bulk
Sender: pgsql-docs-owner@postgresql.org

--001a113efaaef29df60535fd1e6a
Content-Type: text/plain; charset=UTF-8

Ok addendu, it seems like the overview page for catalogs has exactly what I
asked for in the contents page. Any reason they can't be merged? Is it just
the nature of the doc system? As a postgres outsider, it seemed kinda
obtuse.

On Thu, Jun 23, 2016 at 10:37 PM Justin Dearing <zippy1981@gmail.com> wrote:

> 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
>

--001a113efaaef29df60535fd1e6a
Content-Type: text/html; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr">Ok addendu, it seems like the overview page for catalogs h=
as exactly what I asked for in the contents page. Any reason they can&#39;t=
 be merged? Is it just the nature of the doc system? As a postgres outsider=
, it seemed kinda obtuse.</div><br><div class=3D"gmail_quote"><div dir=3D"l=
tr">On Thu, Jun 23, 2016 at 10:37 PM Justin Dearing &lt;<a href=3D"mailto:z=
ippy1981@gmail.com">zippy1981@gmail.com</a>&gt; wrote:<br></div><blockquote=
 class=3D"gmail_quote" style=3D"margin:0 0 0 .8ex;border-left:1px #ccc soli=
d;padding-left:1ex"><div dir=3D"ltr">Switched jobs recently and returning t=
o postgres after a long hiatus. The docs are great, but I noticed a few thi=
ngs =C2=A0that could be improved in the area of catalot documentations.<div=
><br></div><div><ol><li><span style=3D"line-height:1.5">The CREATE/ALTER/DR=
OP doc pages should have a link to the corresponding pg_catalog and INFORMA=
TION_schema tables and views for that object type. The=C2=A0</span><br></li=
><li>pg_catalog docs should have a link to their corresponding information_=
schema table or view and visa versa.</li><li>Perhaps this page (and its ana=
logs)=C2=A0<a href=3D"https://www.postgresql.org/docs/9.1/static/catalogs.h=
tml" target=3D"_blank">https://www.postgresql.org/docs/9.1/static/catalogs.=
html</a>=C2=A0should 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.</li><li>OID columns should have a note saying something to=
 the effect of &quot;to get the text name of this simply use=C2=A0atttypid:=
:REGTYPE&quot;</li><li>I discovered that <a href=3D"http://pg_catalog.name"=
 target=3D"_blank">pg_catalog.name</a> is a built in type today, but its no=
t listed as a built in type. I&#39;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 shou=
ld link to the list of &quot;other built in types&quot; whereever they are.=
</li></ol><div>If any of those suggestions are ameanable where are the docs=
 for contributing to the docs?</div></div><div><br></div><div>Regards,</div=
><div><br></div><div>Justin Dearing</div></div></blockquote></div>

--001a113efaaef29df60535fd1e6a--