#20608 closed New feature (wontfix)
Generic display and editing views description should have Context section
Reported by: | Baptiste Darthenay | Owned by: | Baptiste Darthenay |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Accepted | |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | yes | UI/UX: | no |
Description
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.
Change History (5)
comment:1 by , 11 years ago
Owner: | changed from | to
---|---|
Status: | new → assigned |
comment:2 by , 11 years ago
Triage Stage: | Unreviewed → Accepted |
---|
comment:3 by , 11 years ago
Resolution: | → wontfix |
---|---|
Status: | assigned → closed |
I don't think it's necessary.
comment:4 by , 10 years ago
First off, to whoever had the idea and put in the effort to add the "Method Flowchart" to the CBV and CBGV 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?
- To make the multiple branches of form view logic more explicit. What methods get called when there is a GET? What about a POST?
- 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.
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.