Opened 11 years ago

Closed 10 years ago

#21139 closed Cleanup/optimization (wontfix)

Document django.utils.functional

Reported by: Daniele Procida Owned by: Daniele Procida
Component: Documentation Version: 1.5
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

There are several undocumented classes and functions in django.utils.functional, many of which look as though they deserve to be documented.

See ​https://groups.google.com/forum/#!msg/django-developers/HnkvlACnvr4/OoaHVtaD0_sJ

I propose to start documenting as many of them as possible. Some of the classes and functions have purposes that are not very clear, and they don't conform to any strong pattern or specifications. By starting with the documentation it will help make it clearer which ones need to have stable public APIs and which ones are better left as for-internal-use-only resources.

Change History (4)

comment:1 by Tim Graham, 11 years ago

Triage Stage: Unreviewed → Accepted

comment:2 by Daniele Procida, 11 years ago

Owner: changed from nobody to Daniele Procida
Status: new → assigned

comment:3 by Daniele Procida, 11 years ago

First draft for comments at ​https://github.com/django/django/pull/1777

comment:4 by Tim Graham, 10 years ago

Resolution: → wontfix
Status: assigned → closed

Doesn't seem like this idea has gotten much support.

Note: See TracTickets for help on using tickets.
Back to Top