On Sun, Feb 22, 2009 at 2:06 PM, Ben Sizer <[email protected]> wrote: > > 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.
This is a fairly common request, in fact even seasoned tg devs aren't sure what to delete and what not to delete. The main problem is that the current quickstart has two contradicting goals. 1- provide an introduction/explanation to new people 2- provide a basic package structure for every turbogears project. The issue here is that our current tool to work this (paster template) has some limitation that will not allow us to provide it in two stages. Sadly changing this at this point will break too many apps. Therefore it's a goal for 2.1 http://trac.turbogears.org/ticket/2159 As for what could break and what will not break sadly the answer is delete it and figure it out :) but most stuff in templates (except master and siebars) and controllers (except root and error) can be deleted. I guess the closest thing we can provide for tg2 is a shell script to rm all the not used stuff but that will also be a problem as it will break due to the imports. --~--~---------~--~----~------------~-------~--~----~ 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 -~----------~----~----~----~------~----~------~--~---
