Hi Felix,
Felix Schwarz schrieb:
>
> http://docs.turbogears.org/1.0/ErrorReporting
>
> Are there any specific actions needed to promote this document from draft
> level
> to official or something close to it?
I'd like to give some suggesting, for improving this document. It is very
helpful already and, incidentally, had just the information I was looking for
today, but you godd make it really good, with just a few enhancements:
Code:
- test code with TurboGears 1.0.1
- maybe refactor code for method 2 [1]:
- use more helper methods (e.g. send_error_page)
- use class attributes for static data (error codes)
- use instance attributes, settable through constructor, for
configuration data (email addresses, subject)
- turn it into a class that can be mixed in
- optionally use TurboMail?
- give more explanation, how the code in method 2 works
- links to cherrypy filter docs
- state explicitly how to use the code
Formatting:
- TOC
- Make "References" a section header
Language:
- avoid use of "I did this...", "I find that..."
Extra points awarded for:
- screenshot of error page
- downloadable module and templates
> I like to do some additions, do some
> restructuring and am unsure how to do best. Should I just copy the contents
> on a
> private page and do some basic work which can be reviewed by others?
As Jorge said: this is a wiki, just edit, you can always roll back changes if
needed.
Chris
[1] I will have a go at this today. I can send you the results, if you want.
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
