On Feb 22, 3:54 pm, Mark Ramm <[email protected]> wrote: > > > 2) Quickstart generated code needs more detailed in-code > > documentation. This is greatly needed to get new users up to speed.. > > Any specifics? There is a balance here that's more difficult than it > appears, as every bit of extra stuff in quickstart requires users who > already know what they want to pull it out.
I must admit that when I ran the quickstart recently, I felt there were quite a lot of templates and controllers in there and I didn't know what I could safely remove and what I couldn't. A comment in each template regarding the context in which it is used would be great. And the controllers in root.py could all do with docstrings, as I don't know under what circumstances some of them would be called (eg. post_login, editor_user_only, manage_permission_only, auth). I think making it clear which controllers are ones you navigate to and which ones are used automatically as part of the system would be helpful. -- Ben Sizer --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "TurboGears" 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?hl=en -~----------~----~----~----~------~----~------~--~---
