#9131: Lack of documentation for code under django.utils
---------------------------+------------------------------------------------
 Reporter:  taleinat       |       Owner:  nobody    
   Status:  new            |   Milestone:            
Component:  Documentation  |     Version:  1.0       
 Keywords:                 |       Stage:  Unreviewed
Has_patch:  0              |  
---------------------------+------------------------------------------------
 As a user of Django, I have no idea whether or not I should use the tools
 found under django.utils in my code. Some note, somewhere, regarding this
 would be useful. Maybe I just happened to miss it?

 Additionally, finding things under django.utils is difficult unless you
 search through the code. Just today I was searching for a way to extract
 just the text from some HTML (certainly a simple task, but not one I want
 to write my own code for). It took me some time to find
 django.utils.html.strip_tags. Searching Google for "django strip tags"
 returns some related code snippets and stuff, but no mention of that
 function. The same goes for the custom Google search in the Django
 Documentation website. A reference of some sort (auto-generated?) would be
 helpful just to have something to search through (and for Google to
 munch). It would also be helpful to know the state of different utilities,
 e.g. "deprecated", "stable and well-tested", "likely to change".

-- 
Ticket URL: <http://code.djangoproject.com/ticket/9131>
Django <http://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at 
http://groups.google.com/group/django-updates?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to