Mark Ramm schrieb: > Well, it's a reasonable amount of work, but it sure would be cool to > have something like the "TurboGears Essential Reference" in the docs. > > We really need to move the state of the reference docs forward a bit. > there are reference materials in the current docs, but we could pull > them out and organize them a bit better.
I have written a bit of what I consider an API reference for the 1.0/WidgetsWithJSAndCSS doc. This was only for 5 classes, 1 function and a variable and took me about 2-3 hours, because you have to be very accurate and look forward and backward through the source to get it right. IMHO it is very difficult to write those kind of docs after the code has been released and If you're not the author of the code itself. It has been suggested before that new code should only be accepted if it comes with such a reference, and this writing experience makes me want to agree with that. But nobody said it was going to be easy ;-) Maybe we should start by assigning people to the various modules or sub-packages of TurboGears, to share the load. And one person should organize the efforts by streamlining the docs, coming up with formatting examples, etc. Chris --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "TurboGears Docs" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/turbogears-docs?hl=en -~----------~----~----~----~------~----~------~--~---
