Re: JSON Functions and Operators Docs for v15

From: Andrew Dunstan <andrew(at)dunslane(dot)net>
To: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
Cc: PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: JSON Functions and Operators Docs for v15
Date: 2022-05-14 01:37:54
Message-ID: 044204fa-738d-d89a-0e81-1c04696ba676@dunslane.net
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers


On 2022-05-10 Tu 17:45, Andrew Dunstan wrote:
> On 2022-05-04 We 15:14, Andrew Dunstan wrote:
>> On 2022-05-04 We 11:39, Tom Lane wrote:
>>> "David G. Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com> writes:
>>>> Is there a thread I'm not finding where the upcoming JSON function
>>>> documentation is being made reasonably usable after doubling its size with
>>>> all the new JSON Table features that we've added? If nothing else, the
>>>> table of contents at the top of the page needs to be greatly expanded to
>>>> make seeing and navigating to all that is available a possibility.
>>> The entire structure of that text needs to be rethought, IMO, as it
>>> has been written with precisely no concern for fitting into our
>>> hard-won structure for func.sgml. Andrew muttered something about
>>> rewriting it awhile ago, but I don't know what progress he's made.
>>>
>> Yes, I've been clearing the decks a bit, but I'm working on it now,
>> should have something within the next week.
>
>
> Running slightly long on this. Will definitely post a patch by COB Friday.
>
>

Not done yet but here's where I'm at. If I'm on the wrong track or
missing things that should be done please let me know.

I got rid of all the sub-sub-sub-sections, and put most of the functions
into tables like most other function sections. I added indexterm entries
liberally, and removed a deal of repetitive text. I put json_table in
its own subsection, because it's big enough and important enough, I
think. I reworked some of its docco, particularly around joining of
sibling rows and PLAN DEFAULT, but there's a deal of work still to do to
whip it into shape, which I will continue to do over the weekend.

cheers

andrew

--
Andrew Dunstan
EDB: https://www.enterprisedb.com

Attachment Content-Type Size
sqljson-dox-rework.patch text/x-patch 107.7 KB

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Thomas Munro 2022-05-14 03:01:59 Re: Backends stunk in wait event IPC/MessageQueueInternal
Previous Message Andy Fan 2022-05-14 00:35:53 Re: Making JIT more granular