Opened 18 years ago

Last modified 13 years ago

#3469 closed

Django.utils is not documented — at Version 5

Reported by: Chris Beaven Owned by: nobody
Component: Documentation Version: dev
Severity: Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: no UI/UX: no

Description (last modified by Russell Keith-Magee)

There are a lot of useful utilities and datastructures in django.utils, but the lack of good user documentation limits the extent to which these utilities are used.

For example, DotExpandedDict is a useful but undocumented data structure. It can be very helpful for complex form parsing and it'd be good to mention somewhere in documentation.

Change History (5)

comment:1 by anonymous, 18 years ago

Needs documentation: set

comment:2 by Michael Radziej <mir@…>, 18 years ago

Triage Stage: Unreviewed → Design decision needed

@core: Do we want to document the various classes and functions in django.utils?

comment:3 by emperorcezar, 17 years ago

I think this one in particular needs documentation as it's very useful to a typical end user. I know that I had to ask in the IRC channel to find it originally.

comment:4 by Jacob, 17 years ago

Triage Stage: Design decision needed → Someday/Maybe

Eventually, yes, the general-purpose datastructures in django.utils ought to get documentation.

comment:5 by Russell Keith-Magee, 16 years ago

Description: modified (diff)
Summary: DotExpandedDict is not documented → Django.utils is not documented
Note: See TracTickets for help on using tickets.
Back to Top