[Django] #24162: "Method Flowchart" for all CB(G)V documentation pages
Django
-------------------------------+---------------------------------------
Reporter: ivanvenosdel | Owner: nobody
Type: New feature | Status: new
Component: Documentation | Version: 1.7
Severity: Normal | Keywords: CBV CBGV method flowchart
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+---------------------------------------
First off, to whoever had the idea and put in the effort to add the
"Method Flowchart" to the CBV and CBGV doc pages, thank you, thank you,
thank you. So helpful.
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?
2. 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
--
Ticket URL: <https://code.djangoproject.com/ticket/24162>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: ivanvenosdel | Owner: nobody
Type: New feature | Status: new
Component: Documentation | Version: 1.7
Keywords: CBV CBGV method | Triage Stage:
flowchart | Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by tricoder42):
* needs_better_patch: => 0
* needs_tests: => 0
* needs_docs: => 0
Comment:
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)
--
Ticket URL: <https://code.djangoproject.com/ticket/24162#comment:1>
Django
Reporter: ivanvenosdel | Owner: nobody
Type: New feature | Status: new
Component: Documentation | Version: 1.7
Keywords: CBV CBGV method | Triage Stage:
flowchart | Unreviewed
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by tricoder42):
* cc: tomas.ehrlich@… (added)
--
Ticket URL: <https://code.djangoproject.com/ticket/24162#comment:2>
Django
Reporter: ivanvenosdel | Owner: nobody
Type: New feature | Status: new
Component: Documentation | Version: 1.7
Keywords: CBV CBGV method | Triage Stage: Accepted
flowchart |
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by timgraham):
* stage: Unreviewed => Accepted
Comment:
An example "Method Flowchart" is here:
https://docs.djangoproject.com/en/dev/ref/class-based-views/generic-
display/#listview.
--
Ticket URL: <https://code.djangoproject.com/ticket/24162#comment:3>
Django
Reporter: ivanvenosdel | Owner: nobody
Type: New feature | Status: new
Component: Documentation | Version: 1.7
Keywords: CBV CBGV method | Triage Stage: Accepted
flowchart |
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Description changed by ivanvenosdel:
Old description:
> First off, to whoever had the idea and put in the effort to add the
> "Method Flowchart" to the CBV and CBGV doc pages, thank you, thank you,
> thank you. So helpful.
>
> 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?
>
> 2. 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
New description:
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?
2. 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
--
--
Ticket URL: <https://code.djangoproject.com/ticket/24162#comment:4>
Django
Reporter: Ivan Ven Osdel | Owner: Clifford
| Gama
Type: New feature | Status: assigned
Component: Documentation | Version: 1.7
Keywords: CBV CBGV method | Triage Stage: Accepted
flowchart |
Has patch: 0 | Needs documentation: 0
Changes (by Clifford Gama):
* cc: Clifford Gama (added)
* owner: nobody => Clifford Gama
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/24162#comment:5>
Django
Reporter: Ivan Ven Osdel | Owner: Clifford
| Gama
Type: New feature | Status: assigned
Keywords: CBV CBGV method | Triage Stage: Accepted
flowchart |
Has patch: 0 | Needs documentation: 0
Comment (by Clifford Gama):
I think this ticket may have to be addressed along with #19227 (Reorganize
method flowchart for class based generic views to tree), as the method
flowcharts would be more accurate and helpful in tree form as opposed to
current lists.
--
Ticket URL: <https://code.djangoproject.com/ticket/24162#comment:6>
Django
Reporter: Ivan Ven Osdel | Owner: (none)
Component: Documentation | Version: 1.7
Keywords: CBV CBGV method | Triage Stage: Accepted
flowchart |
Has patch: 0 | Needs documentation: 0
Changes (by Clifford Gama):
* owner: Clifford Gama => (none)
* status: assigned => new
--
Ticket URL: <https://code.djangoproject.com/ticket/24162#comment:7>