On Fri, Aug 26, 2011 at 12:02 PM, Jakob Kummerow <[email protected]>wrote:
> On Fri, Aug 26, 2011 at 11:53, Stephan Beal <[email protected]> wrote: > >> This is a good opportunity to remind developers that if we have decent >> documentation, that "weeks" might be cut down to "week" or "days". >> > > True, I fully agree that it'd be great to have more/better documentation. > However, writing documentation (and keeping it up to date!) takes a > non-trivial amount of time, and so far > After sending that i realized that detailed docs for implementation details is of course not realistic (regardless of the project, except for life-critical stuff like space missions, flight control, nuclear reactors, and whatnot). V8's stance has been that developers' time is better spent on developing... > maybe we'll manage to arrive at some sort of compromise. We'll gladly accept > any help ;-) > i would be more than happy to write API docs for v8 (i write _tons_ of API/HOWTO docs), but doing it would almost certainly require administrative support from Google (e.g. access to and cooperation from the developers). If i, as a guy off the street, were to write v8 devs and say, "hey, i'm here to write your docs, please tell help me understand the exact semantics of functions (A), (B), and (C)," they'd think, "I can't book this time, i.e. no way." If, on the other hand, one of the dev managers said, "hey, this guy's here to write your code, please help him understand..." it would at least have a chance of ever being finished. i.e. i think v8 is of a size that an outsider can't simply sit down and decode it all from start to finish, and document all of the semantics (i'm a stickler for semantics). i've been using v8 for a long time now (going on 3 years), but i have intentionally kept my nose out of the code because as a library author i believe that users must be able to use the code without reverting to the sources (unless they're doing so with the intention of filling a gap in the documentation). But (and i've said this before): pass this on to the v8 management, and if they'll give me (or the company i work for) a contract to WTFM, then i'd be thrilled to WTFM. :) -- ----- stephan beal http://wanderinghorse.net/home/stephan/ -- v8-users mailing list [email protected] http://groups.google.com/group/v8-users
