Opened 11 years ago

Last modified 27 hours ago

#19227 new Cleanup/optimization

Reorganize method flowchart for class based generic views to tree

Reported by: shoul@… Owned by:
Component: Documentation Version: dev
Severity: Normal Keywords: docs
Cc: Florian Apolloner, Ülgen Sarıkavak 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)

generic-display.txt.diff (1.8 KB ) - added by ohumbel 11 years ago.
render both detail and list method flowcharts as tree structures

Download all attachments as: .zip

Change History (18)

comment:1 by Florian Apolloner, 11 years ago

Cc: Florian Apolloner added
Triage Stage: UnreviewedAccepted

As seen on a pycon-de presentation, a treelike structure is easier to follow visually.

comment:2 by Tim Graham, 11 years ago

Component should be documentation I assume? What page does this refer to?

comment:3 by ohumbel, 11 years ago

This refers to: /ref/class-based-views/generic-display.html,
source: /docs/ref/class-based-views/generic-display.txt

by ohumbel, 11 years ago

Attachment: generic-display.txt.diff added

render both detail and list method flowcharts as tree structures

comment:4 by ohumbel, 11 years ago

please note that the space before a dedent is due to the css

comment:5 by Tim Graham, 11 years ago

Component: UncategorizedDocumentation

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 Daniel Greenfeld, 11 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.

Last edited 11 years ago by Daniel Greenfeld (previous) (diff)

comment:7 by Garry Polley, 11 years ago

Owner: changed from nobody to Garry Polley
Status: newassigned

comment:8 by Garry Polley, 11 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 Steven Cummings, 11 years ago

@garrypolley would this include new info in the "writing documentation" section of the contributing HOWTOs?

comment:10 by Garry Polley, 11 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 Garry Polley, 11 years ago

Cc: Garry Polley added

comment:12 by Garry Polley, 11 years ago

Cc: Garry Polley removed

comment:13 by Garry Polley, 11 years ago

Owner: Garry Polley removed
Status: assignednew

comment:14 by jambonrose, 11 years ago

Owner: set to jambonrose
Status: newassigned

comment:15 by Tim Graham, 11 years ago

Easy pickings: unset

comment:16 by Mariusz Felisiak, 3 years ago

Owner: jambonrose removed
Status: assignednew

comment:17 by Ülgen Sarıkavak, 27 hours ago

Cc: Ülgen Sarıkavak added
Note: See TracTickets for help on using tickets.
Back to Top