> 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 ;-)
Agreed! If we can get these docs in place we can move things forward to a if you add it you've got to document it (or con somebody else into documenting it for you) basis for future development. > Maybe we should start by assigning > people to the various modules or sub-packages of TurboGears, to share the > load. Absolutely. For the TurboGears core we would need to document: Widgets Identity Expose Validate Error handling Exception handling Paginate decorator And I'm sure quite a bit more. I think to do this at a reasonable pace, we'll need several volunteers. But some things, like [EMAIL PROTECTED] doc, have stuff that we'll need alreay written. > And one person should organize the efforts by streamlining the docs, coming up > with formatting examples, etc. Sounds like a good first step would be to create a couple of sample pages. I'll look at the widget+CSS+JavaScript doc you've created to see if it makes sense to make that part of our "reference implementation." --Mark --~--~---------~--~----~------------~-------~--~----~ 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 -~----------~----~----~----~------~----~------~--~---
