Re: Error documentation, more thoughts

2012-03-22 Thread Daniel Ruggeri
On 3/22/2012 6:45 AM, Rich Bowen wrote: > Yeah, this might be the right approach. The only difficulty here is > the question of localization. Until we localize our error messages, > localization of the documentation of those error messages seems a very > useful thing to have. It might not be diffi

Re: Error documentation, more thoughts

2012-03-22 Thread Rich Bowen
On Mar 21, 2012, at 9:34 PM, Daniel Ruggeri wrote: > So, follow my train of thought if you will... I know a lot of this is > still up in the air so I'm brainstorming. Is it terrible to document > every error code on an individual wiki page starting with the error > message in the log and a small

Re: Error documentation, more thoughts

2012-03-21 Thread Daniel Ruggeri
On 3/15/2012 3:36 PM, Rich Bowen wrote: > > On Mar 15, 2012, at 4:23 PM, William A. Rowe Jr. wrote: > >> On 3/15/2012 3:16 PM, Eric Covener wrote: >>> I'd just as well add supplementary info to a wiki for the specific >>> message IDs that require extra discussion. I've never been a fan of >>> the

Re: Error documentation, more thoughts

2012-03-15 Thread Rich Bowen
On Mar 15, 2012, at 4:23 PM, William A. Rowe Jr. wrote: > On 3/15/2012 3:16 PM, Eric Covener wrote: >> I'd just as well add supplementary info to a wiki for the specific >> message IDs that require extra discussion. I've never been a fan of >> the massive "messages" publication that's 98% the ve

Re: Error documentation, more thoughts

2012-03-15 Thread William A. Rowe Jr.
On 3/15/2012 3:16 PM, Eric Covener wrote: > I'd just as well add supplementary info to a wiki for the specific > message IDs that require extra discussion. I've never been a fan of > the massive "messages" publication that's 98% the verbatim error text > phrased three different ways. I'm actually

Re: Error documentation, more thoughts

2012-03-15 Thread Eric Covener
I'd just as well add supplementary info to a wiki for the specific message IDs that require extra discussion. I've never been a fan of the massive "messages" publication that's 98% the verbatim error text phrased three different ways. --

Re: Error documentation, more thoughts

2012-03-15 Thread Rich Bowen
On Mar 15, 2012, at 2:55 PM, Tim Bannister wrote: > On 15 Mar 2012, at 12:14, Rich Bowen wrote: > >> I really don't want one enormous file > > Can you say why not? My preferences (for what it's worth) would either be the > one huge file or the doxygen-like comments. In both cases, patches that

Re: Error documentation, more thoughts

2012-03-15 Thread Tim Bannister
On 15 Mar 2012, at 12:14, Rich Bowen wrote: > I really don't want one enormous file Can you say why not? My preferences (for what it's worth) would either be the one huge file or the doxygen-like comments. In both cases, patches that change the help for an error code should still be easy to rea

Re: Error documentation, more thoughts

2012-03-15 Thread Rich Bowen
On Mar 12, 2012, at 5:25 AM, Stefan Fritsch wrote: > On Sunday 11 March 2012, Rich Bowen wrote: >> On Mar 11, 2012, at 10:31, Stefan Fritsch wrote: >>> A doxygen-like comment that resides in the *.c file right above >>> the log call may be even more easy to edit for developers. There >>> would b

Re: Error documentation, more thoughts

2012-03-12 Thread Rich Bowen
On Mar 12, 2012, at 5:25 AM, Stefan Fritsch wrote: > On Sunday 11 March 2012, Rich Bowen wrote: >> On Mar 11, 2012, at 10:31, Stefan Fritsch wrote: >>> A doxygen-like comment that resides in the *.c file right above >>> the log call may be even more easy to edit for developers. There >>> would b

Re: Error documentation, more thoughts

2012-03-12 Thread Rich Bowen
On Mar 12, 2012, at 5:25, Stefan Fritsch wrote: > OTOH, this would prevent people with only docs commit access to edit > the comment. I didn't think there were any such any more. -- Rich Bowen, mobile edition - To unsub

Re: Error documentation, more thoughts

2012-03-12 Thread Stefan Fritsch
On Sunday 11 March 2012, Rich Bowen wrote: > On Mar 11, 2012, at 10:31, Stefan Fritsch wrote: > > A doxygen-like comment that resides in the *.c file right above > > the log call may be even more easy to edit for developers. There > > would be a script that extracts these comments and puts them >

Re: Error documentation, more thoughts

2012-03-11 Thread Rich Bowen
On Mar 11, 2012, at 10:31, Stefan Fritsch wrote: > > A doxygen-like comment that resides in the *.c file right above the log call > may be even more easy to edit for developers. There would be a script that > extracts these comments and puts them into xml files in the docs. See, I knew th

Re: Error documentation, more thoughts

2012-03-11 Thread Stefan Fritsch
On Fri, 9 Mar 2012, Rich Bowen wrote: I wanted to share this transcript from IRC, just to see what people think of the idea. [10:15] It would be nice (this is just wishful thinking) if when a AH code is created, there was a piece of documentation that was created along with it listing

Error documentation, more thoughts

2012-03-09 Thread Rich Bowen
I wanted to share this transcript from IRC, just to see what people think of the idea. [10:15] It would be nice (this is just wishful thinking) if when a AH code is created, there was a piece of documentation that was created along with it listing a more detailed explanation of what the