Karl Guertin wrote:
> I still don't understand what is wrong enough with widgets that the
> wheel needs to be reinvented. I know they have limitations but you've
> never given a reason to avoid them. I keep asking this because I plan
> on trying to document issues people have with the framework.

The main problem with widgets is... *drumroll* documentation.

 - The first mention of widget on
http://www.turbogears.org/preview/docs/ talks about Javascript widgets,
before any entry on Widgets more generally; this is likely to make
people think widgets are just about Javascript. (This is apparently
fixed in the new docs, but then the new docs lack the following
page...)

 - The following mention is 'Widgets/Forms', which is all well and good
except it doesn't even attempt to say what a widget is until paragraph
20! Even then, the description is somewhat abstract and vague. On a
page about widgets, a good description of a widget should be in
paragraph 1. Let the user know he's looking at the right page.

 - The sample code isn't well explained. Why use 'TableForm'? What
alternatives are there to 'TableForm'? What alternatives are there to
TextField?

 - Why is the validation section talking about invisible examples? (eg.
"It's fairly obvious that the first field (validators.NotEmpty)is
required", yet that is the only mention of validators.NotEmpty on that
page). Maybe this code is hidden away in the .tgz file, but
documentation has to stop being a collection of tutorials you download
and work through, and start being more like proper reference material.
I should be able to learn from reading, not by being led through 5 or 6
tutorials.

etc. I apologise for the uncompromising nature of my complaints but
sometimes it seems that people do not recognise what the actual problem
with the docs is. I do appreciate it's a lot easier to point out
failings than to fix them, however. I can't speak for the original
poster, but this is certainly why I am unwilling to waste my time on
widgets until there is a decent reference to work with.

-- 
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
-~----------~----~----~----~------~----~------~--~---

Reply via email to