RFE: "Best of both worlds" for short and long?
|Reported by:||JonathanHayward||Owned by:||nobody|
|Has patch:||no||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
http://neverfear.org/blog/view/123/Auto_Generate_Forms_With_Django_s_ModelForm (which may not be distilled as far as "short and sweet" allows) says, "Here's how to use Django ModelForm in a nutshell; if you want to dive in, consult the official docs."
I don't know that all areas of Django admit as good a "short and sweet" version where 10% of the material covered in the official documentation covers 90% of the use, but would it make sense to have, in the documentation, a "short and sweet nutshell" section at the top, and then "full details" which would be largely unedited versions of the existing documentation? Again, I don't know that this area is representative, but existing Django docs would be improved by having something do the job an abstract does in an academic publication. Even if someone really needs the full details, a brief orientation in the nutshell might help ward off "can't see the forest for the trees" syndrome.