Re: documentation structure - Mailing list pgsql-hackers

From Tom Lane
Subject Re: documentation structure
Date
Msg-id 3992770.1721335249@sss.pgh.pa.us
Whole thread Raw
In response to Re: documentation structure  (Andrew Dunstan <andrew@dunslane.net>)
List pgsql-hackers
Andrew Dunstan <andrew@dunslane.net> writes:
> I'm opposed to having a separate file for every function.

I also think that would be a disaster.  It would result in a huge
number of files which would make global editing (eg markup changes)
really painful, and it by no means flattens the document structure.
Somewhere there will still need to be decisions that functions
A, B, C go into one documentation section while D, E, F go somewhere
else.

> I think 
> breaking up func.sgml into one piece per sect1 is about right. If that 
> proves cumbersome still we can look at breaking it up further, but let's 
> start with that.

+1

            regards, tom lane



pgsql-hackers by date:

Previous
From: Andrew Dunstan
Date:
Subject: Re: documentation structure
Next
From: Tomas Vondra
Date:
Subject: Re: Report search_path value back to the client.