[Django] #20608: Generic display and editing views description should have Context section
Django
-------------------------------+--------------------
Reporter: batisteo | Owner: nobody
Type: New feature | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------+--------------------
As the generic date views have a `Context` section for each view, I guess
both generic display and editing views should have a context section too,
below `Ancestors (MRO)`.
[https://docs.djangoproject.com/en/dev/ref/class-based-views/]
If necessary, they might need a `Method Flowchart` and `Notes` sections
too, before code examples.
--
Ticket URL: <https://code.djangoproject.com/ticket/20608>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: batisteo | Owner: batisteo
Type: New feature | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by batisteo):
* status: new => assigned
* needs_docs: => 0
* owner: nobody => batisteo
* needs_tests: => 0
* needs_better_patch: => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/20608#comment:1>
Django
Reporter: batisteo | Owner: batisteo
Type: New feature | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by timo):
* stage: Unreviewed => Accepted
Comment:
It looks like these sections may not be present because the classes only
have context from their mixins. It would be worthwhile to at least point
this out and link to the appropriate sections of those mixins.
--
Ticket URL: <https://code.djangoproject.com/ticket/20608#comment:2>
Django
Reporter: batisteo | Owner: batisteo
Component: Documentation | Version: master
Severity: Normal | Resolution: wontfix
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by batisteo):
* status: assigned => closed
* resolution: => wontfix
Comment:
I don't think it's necessary.
--
Ticket URL: <https://code.djangoproject.com/ticket/20608#comment:3>
Django
Reporter: batisteo | Owner: batisteo
Type: New feature | Status: closed
Severity: Normal | Resolution: wontfix
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (by ivanvenosdel):
First off, to whoever had the idea and put in the effort to add the
"Method Flowchart" to the CBV and CBVGV 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.
I would be happy to submit my request as a new ticket if that is more
appropriate.
--
Ticket URL: <https://code.djangoproject.com/ticket/20608#comment:4>
Django
Reporter: batisteo | Owner: batisteo
Type: New feature | Status: closed
Severity: Normal | Resolution: wontfix
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (by timgraham):
Yes, this ticket is closed.
--
Ticket URL: <https://code.djangoproject.com/ticket/20608#comment:5>