Re: SQL/JSON: documentation - Mailing list pgsql-hackers

From Peter Eisentraut
Subject Re: SQL/JSON: documentation
Date
Msg-id 6d7ca4f7-bc50-a5a5-ec88-73e0a0d0b65a@2ndquadrant.com
Whole thread Raw
In response to SQL/JSON: documentation  (Nikita Glukhov <n.gluhov@postgrespro.ru>)
Responses Re: SQL/JSON: documentation  (Andrew Dunstan <andrew.dunstan@2ndquadrant.com>)
Re: SQL/JSON: documentation  (Liudmila Mantrova <l.mantrova@postgrespro.ru>)
List pgsql-hackers
On 28/06/2018 01:36, Nikita Glukhov wrote:
> Attached patch with draft of SQL/JSON documentation written by
> Liudmila Mantrova, Oleg Bartunov and me.
> 
> Also it can be found in our sqljson repository on sqljson_doc branch:
> https://github.com/postgrespro/sqljson/tree/sqljson_doc
> 
> We continue to work on it.

Some structural comments:

- I don't think this should be moved to a separate file.  Yes, func.sgml
is pretty big, but if we're going to split it up, we should do it in a
systematic way, not just one section.

- The refentries are not a bad idea, but again, if we just used them for
this one section, the navigation will behave weirdly.  So I'd do it
without them, just using normal subsections.

- Stick to one-space indentation in XML.

-- 
Peter Eisentraut              http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services


pgsql-hackers by date:

Previous
From: Alvaro Herrera
Date:
Subject: Re: executor relation handling
Next
From: Peter Geoghegan
Date:
Subject: Re: Making all nbtree entries unique by having heap TIDs participatein comparisons