Opened 4 years ago

Last modified 3 years ago

#24162 new New feature

"Method Flowchart" for all CB(G)V documentation pages

Reported by: Ivan Ven Osdel Owned by: nobody
Component: Documentation Version: 1.7
Severity: Normal Keywords: CBV CBGV method flowchart
Cc: tomas.ehrlich@… Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by Ivan Ven Osdel)

First off, to whoever had the idea and put in the effort to add the "Method Flowchart" to some of the CBV and CBGV doc pages, thank you, thank you, thank you. So helpful.

Example "Method Flowchart": ​https://docs.djangoproject.com/en/dev/ref/class-based-views/generic-display/#listview

So naturally I would love to see the feature on all of the CB(G)V pages, particularly those with a form as they are more complicated.

Why is this necessary?

  1. To make the multiple branches of form view logic more explicit. What methods get called when there is a GET? What about a POST?
  1. To gain all the advantages that the "Method Flow" chart has provided to the other views. For me it has been primarily helpful for understanding and figuring out how to avoid duplicate queries.

Moved from comment on: ticket:20608

Change History (4)

comment:1 Changed 4 years ago by Tomáš Ehrlich

I'm a bit confused by your description (I've never heard of "Method flowchart"), but if you want to see whole ancestors tree with all methods (and code snippets!), have a look at http://ccbv.co.uk

The question whether this should be included in docs remains. Personally I use http://ccbv.co.uk a lot. Without this site the CBV would be very hard to customize (yes, I still can browse the source code, but it isn't definitely as convenient as http://ccbv.co.uk)

comment:2 Changed 4 years ago by Tomáš Ehrlich

Cc: tomas.ehrlich@… added

comment:3 Changed 3 years ago by Tim Graham

Triage Stage: UnreviewedAccepted

comment:4 Changed 3 years ago by Ivan Ven Osdel

Description: modified (diff)
Note: See TracTickets for help on using tickets.
Back to Top