Re: complex documentation and hard to find the reference

From: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
To: saikiran(dot)rachakonda(at)vasudhaika(dot)net, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: complex documentation and hard to find the reference
Date: 2018-02-12 14:47:31
Message-ID: CAKFQuwbeuPmK8bD4ohDar6wQWoW9uScgY9j+zhByQK6mi3pDAw@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Mon, Feb 12, 2018 at 7:01 AM, PG Doc comments form <
noreply(at)postgresql(dot)org> wrote:

> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/9.5/static/functions-json.html
> Description:
>
> with the prior experience of mysql or mongoDb or any other. Documentation
> can be understood. But without any experience of those, hard to try the
> JSONB data type.
>
>
​The functions chapter assumes that one has read the earlier "Data Types"
chapter for JSON first. There are many examples there.

https://www.postgresql.org/docs/10/static/datatype-json.html

> Specify operand places in a select query (give the entire example query).
>

​That would be unnecessarily verbose in almost all cases. Is there a
specific one that is particularly confusing for which a more detailed
example should provided?

The function reference chapter assumes that people know how to write
queries and just need to know which functions are available. Other
chapters in the documentation cover describing how to do the former.​

​David J.

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Bart Lengkeek 2018-02-15 09:01:30 error fields
Previous Message PG Doc comments form 2018-02-12 14:01:52 complex documentation and hard to find the reference