[Django] #19227: Reorganize method flowchart for class based generic views to tree
Django
--------------------------------------+--------------------
Reporter: shoul@… | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Uncategorized | Version: master
Severity: Normal | Keywords: docs
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+--------------------
It would be nice to have a tree that build up the flowchart.
--
Ticket URL: <https://code.djangoproject.com/ticket/19227>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: shoul@… | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Uncategorized | Version: master
Keywords: docs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by apollo13):
* cc: apollo13 (added)
* needs_docs: => 0
* needs_better_patch: => 0
* needs_tests: => 0
* stage: Unreviewed => Accepted
Comment:
As seen on a pycon-de presentation, a treelike structure is easier to
follow visually.
--
Ticket URL: <https://code.djangoproject.com/ticket/19227#comment:1>
Django
Reporter: shoul@… | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Uncategorized | Version: master
Keywords: docs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (by timo):
Component should be documentation I assume? What page does this refer to?
--
Ticket URL: <https://code.djangoproject.com/ticket/19227#comment:2>
Django
Reporter: shoul@… | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Uncategorized | Version: master
Keywords: docs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (by ohumbel):
This refers to: /ref/class-based-views/generic-display.html,
source: /docs/ref/class-based-views/generic-display.txt
--
Ticket URL: <https://code.djangoproject.com/ticket/19227#comment:3>
Django
Reporter: shoul@… | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Uncategorized | Version: master
Keywords: docs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (by ohumbel):
please note that the space before a dedent is due to the css
--
Ticket URL: <https://code.djangoproject.com/ticket/19227#comment:4>
Django
Reporter: shoul@… | Owner: nobody
Type: Cleanup/optimization | Status: new
Severity: Normal | Resolution:
Keywords: docs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by timo):
* component: Uncategorized => Documentation
Comment:
Ah, makes sense. Would also be helpful to add a description of what the
"method flowchart" is trying to show I think.
--
Ticket URL: <https://code.djangoproject.com/ticket/19227#comment:5>
Django
Reporter: shoul@… | Owner: nobody
Type: Cleanup/optimization | Status: new
Severity: Normal | Resolution:
Keywords: docs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (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.
--
Ticket URL: <https://code.djangoproject.com/ticket/19227#comment:6>
Django
Reporter: shoul@… | Owner:
Type: | garrypolley
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: docs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by garrypolley):
* status: new => assigned
* owner: nobody => garrypolley
--
Ticket URL: <https://code.djangoproject.com/ticket/19227#comment:7>
Django
Reporter: shoul@… | Owner:
Type: | garrypolley
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: docs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (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.
--
Ticket URL: <https://code.djangoproject.com/ticket/19227#comment:8>
Django
Reporter: shoul@… | Owner:
Type: | garrypolley
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: docs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (by estebistec):
@garrypolley would this include new info in the "writing documentation"
section of the contributing HOWTOs?
--
Ticket URL: <https://code.djangoproject.com/ticket/19227#comment:9>
Django
Reporter: shoul@… | Owner:
Type: | garrypolley
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: docs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (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.
--
Ticket URL: <https://code.djangoproject.com/ticket/19227#comment:10>
Django
Reporter: shoul@… | Owner:
Type: | garrypolley
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: docs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by garrypolley):
* cc: garrypolley (added)
--
Ticket URL: <https://code.djangoproject.com/ticket/19227#comment:11>
Django
Reporter: shoul@… | Owner:
Type: | garrypolley
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: docs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by garrypolley):
* cc: garrypolley (removed)
--
Ticket URL: <https://code.djangoproject.com/ticket/19227#comment:12>
Django
Reporter: shoul@… | Owner:
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: docs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by garrypolley):
* status: assigned => new
* owner: garrypolley =>
--
Ticket URL: <https://code.djangoproject.com/ticket/19227#comment:13>
Django
Reporter: shoul@… | Owner:
Type: | jambonrose
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: docs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by jambonrose):
* owner: => jambonrose
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/19227#comment:14>
Django
Reporter: shoul@… | Owner:
Type: | jambonrose
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: docs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Changes (by timo):
* easy: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/19227#comment:15>
Django
Reporter: shoul@… | Owner: (none)
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: docs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Mariusz Felisiak):
* owner: jambonrose => (none)
* status: assigned => new
--
Ticket URL: <https://code.djangoproject.com/ticket/19227#comment:16>
Django
Reporter: shoul@… | Owner: (none)
Component: Documentation | Version: dev
Keywords: docs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------
* cc: Ülgen Sarıkavak (added)
--
Ticket URL: <https://code.djangoproject.com/ticket/19227#comment:17>
Django
Reporter: shoul@… | Owner: Clifford
Type: | Gama
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: docs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Clifford Gama):
* cc: Clifford Gama (added)
* owner: (none) => Clifford Gama
Ticket URL: <https://code.djangoproject.com/ticket/19227#comment:18>
Django
Reporter: shoul@… | Owner: (none)
Severity: Normal | Resolution:
Keywords: docs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Clifford Gama):
* owner: Clifford Gama => (none)
related #24162
--
Ticket URL: <https://code.djangoproject.com/ticket/19227#comment:19>