Opened 3 years ago

Last modified 23 months ago

#19227 assigned Cleanup/optimization

Reorganize method flowchart for class based generic views to tree

Reported by: shoul@… Owned by: jambonrose
Component: Documentation Version: master
Severity: Normal Keywords: docs
Cc: apollo13 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 3 years ago.
render both detail and list method flowcharts as tree structures

Download all attachments as: .zip

Change History (16)

comment:1 Changed 3 years ago by apollo13

  • Cc apollo13 added
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

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

comment:2 Changed 3 years ago by timo

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

comment:3 Changed 3 years ago by ohumbel

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

Changed 3 years ago by ohumbel

render both detail and list method flowcharts as tree structures

comment:4 Changed 3 years ago by ohumbel

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

comment:5 Changed 3 years ago by timo

  • Component changed from Uncategorized to 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 Changed 3 years ago by pydanny

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. 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.

Version 0, edited 3 years ago by pydanny (next)

comment:7 Changed 2 years ago by garrypolley

  • Owner changed from nobody to garrypolley
  • Status changed from new to assigned

comment:8 Changed 2 years ago by garrypolley

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 Changed 2 years ago by estebistec

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

comment:10 Changed 2 years ago by garrypolley

@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 Changed 2 years ago by garrypolley

  • Cc garrypolley added

comment:12 Changed 2 years ago by garrypolley

  • Cc garrypolley removed

comment:13 Changed 2 years ago by garrypolley

  • Owner garrypolley deleted
  • Status changed from assigned to new

comment:14 Changed 2 years ago by jambonrose

  • Owner set to jambonrose
  • Status changed from new to assigned

comment:15 Changed 23 months ago by timo

  • Easy pickings unset
Note: See TracTickets for help on using tickets.
Back to Top