Opened 12 years ago
Closed 12 years ago
#18451 closed Cleanup/optimization (fixed)
Improved class based view documentation
Reported by: | Daniel Greenfeld | Owned by: | nobody |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | |
Cc: | James Aylett, Marc Tamlyn | Triage Stage: | Unreviewed |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | yes |
Easy pickings: | no | UI/UX: | no |
Description
Ref Improvements:
- Documentation moved to /ref/class-based-views/ directory.
- Method Resolution Order (MRO) on most views.
- Method flowchart added to many views.
- Mixins moved to their own pages.
- Mixins demonstrate which other Mixins they extend.
- Autodoc added to all views and mixins.
- Because the Django code does always not contain docstrings, or it is not complete, there remains in many cases the old manual documentation.
- 'Note' statements placed whenever autodoc is in addition to manual documentation.
Topic Improvements:
- Documentation moved to /topics/class-based-views/ directory.
- Cleaner explanation including additional examples.
- More examples.
- Mixins moved to their own pages.
- Very clean mixin documentation with advocacy for best practices.
Authors:
- Daniel Greenfeld
- James Aylett
- Marc Tamlyn
- Simon Williams
Change History (3)
comment:1 by , 12 years ago
comment:2 by , 12 years ago
Patch needs improvement: | set |
---|
comment:3 by , 12 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
Note:
See TracTickets
for help on using tickets.
Pull request https://github.com/django/django/pull/144