Opened 3 years ago

Closed 3 years ago

Last modified 22 months ago

#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: master
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


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

If necessary, they might need a Method Flowchart and Notes sections too, before code examples.

Change History (5)

comment:1 Changed 3 years ago by Baptiste Darthenay

Needs documentation: unset
Needs tests: unset
Owner: changed from nobody to Baptiste Darthenay
Patch needs improvement: unset
Status: newassigned

comment:2 Changed 3 years ago by Tim Graham

Triage Stage: UnreviewedAccepted

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.

comment:3 Changed 3 years ago by Baptiste Darthenay

Resolution: wontfix
Status: assignedclosed

I don't think it's necessary.

comment:4 Changed 22 months ago by Ivan Ven Osdel

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?

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

Last edited 22 months ago by Ivan Ven Osdel (previous) (diff)

comment:5 Changed 22 months ago by Tim Graham

Yes, this ticket is closed.

Note: See TracTickets for help on using tickets.
Back to Top