Opened 12 years ago
Last modified 4 weeks ago
#19227 assigned Cleanup/optimization
Reorganize method flowchart for class based generic views to tree
Reported by: | Owned by: | Clifford Gama | |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | docs |
Cc: | Florian Apolloner, Ülgen Sarıkavak, Clifford Gama | Triage Stage: | Accepted |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
It would be nice to have a tree that build up the flowchart.
Attachments (1)
Change History (19)
comment:1 by , 12 years ago
Cc: | added |
---|---|
Triage Stage: | Unreviewed → Accepted |
comment:2 by , 12 years ago
Component should be documentation I assume? What page does this refer to?
comment:3 by , 12 years ago
This refers to: /ref/class-based-views/generic-display.html,
source: /docs/ref/class-based-views/generic-display.txt
by , 12 years ago
Attachment: | generic-display.txt.diff added |
---|
render both detail and list method flowcharts as tree structures
comment:5 by , 12 years ago
Component: | Uncategorized → Documentation |
---|
Ah, makes sense. Would also be helpful to add a description of what the "method flowchart" is trying to show I think.
comment:6 by , 12 years ago
I would love to have a tree view of the method flowchart. In fact, that is what I originally submitted. However...
Even a Tree view is not adequate. Trying to describe if/else boolean logic in bullets turns out to be rather confusing. The methods really need a proper flowchart, not a text tree. Something perhaps even done in Graphviz.
Indeed, months ago @Jacobian started to work it in Graphviz and then ran out of free time while working on the format for the Method flowchart.
comment:7 by , 12 years ago
Owner: | changed from | to
---|---|
Status: | new → assigned |
comment:8 by , 12 years ago
I've started taking a look at a gist from @Jacobian https://gist.github.com/jacobian/5020615. I want to attempt to find a way to automate the creation of these graphs.
Either way I'll try and get some more graphs done this Django sprint.
comment:9 by , 12 years ago
@garrypolley would this include new info in the "writing documentation" section of the contributing HOWTOs?
comment:10 by , 12 years ago
@estebistec I do not plan to update the "writing documentation" section. After looking into writing a graph generator and talking to @jacobian I don't think it's a good idea to make the graphs. It's rather difficult and where do you decide to start the graph? Do you start at dispatch? Do you list every method call in side each method?
Looking into ccbv.co.uk and seeing if there is a good way to fork it so it will auto generate a version with each django release/branch. I think ccbv.co.uk does a good job of showing what you can access on a CBV and it's more detailed than a graph would be. I'm not convinced a graph or flow chart is better than just using that site.
comment:11 by , 12 years ago
Cc: | added |
---|
comment:12 by , 11 years ago
Cc: | removed |
---|
comment:13 by , 11 years ago
Owner: | removed |
---|---|
Status: | assigned → new |
comment:14 by , 11 years ago
Owner: | set to |
---|---|
Status: | new → assigned |
comment:15 by , 11 years ago
Easy pickings: | unset |
---|
comment:16 by , 4 years ago
Owner: | removed |
---|---|
Status: | assigned → new |
comment:17 by , 8 months ago
Cc: | added |
---|
comment:18 by , 4 weeks ago
Cc: | added |
---|---|
Owner: | set to |
Status: | new → assigned |
As seen on a pycon-de presentation, a treelike structure is easier to follow visually.