Opened 3 years ago

Closed 3 years ago

#18451 closed Cleanup/optimization (fixed)

Improved class based view documentation

Reported by: pydanny Owned by: nobody
Component: Documentation Version: master
Severity: Normal Keywords:
Cc: jaylett, mjtamlyn Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: no UI/UX: no


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.


  • Daniel Greenfeld
  • James Aylett
  • Marc Tamlyn
  • Simon Williams

Change History (3)

comment:1 Changed 3 years ago by pydanny

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

comment:2 Changed 3 years ago by mjtamlyn

  • Patch needs improvement set

comment:3 Changed 3 years ago by Jannis Leidel <jannis@…>

  • Resolution set to fixed
  • Status changed from new to closed

In [c4c7fbcc0d9264beb931b45969fc0d8d655c4f83]:

Fixed #18451 -- Vastly improved class based view documentation.

Many thanks to Daniel Greenfeld, James Aylett, Marc Tamlyn, Simon Williams, Danilo Bargen and Luke Plant for their work on this.

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