Opened 5 years ago

Closed 5 years ago

#13738 closed (wontfix)

"Writing Views" doesn't help much if you want in-depth info on writing views

Reported by: JonathanHayward Owned by: nobody
Component: Documentation Version: 1.2
Severity: Keywords: Enhancement
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description as it exists now might more appropriately be called "Assigning error views" or something similar.

What it does not give is any particular detail about how to write an interesting view for a normal, i.e. 200 case. The views take a request object but do not demonstrate how to read CGI form variables from the request, and I would expect there's a lot more that can and should be said about writing views for a normal status 200 response than is said.

I don't know if the expanded documentation should be in this page or another, but any page labelled "Writing Views" page should be a detailed page covering most of the bases for how one writes a view for a normal (200) response, and workhorses like retrieving submitted CGI variables. It might also include what the present page does, but right now the "Writing Views" page isn't doing what a page with that name should do.


Change History (2)

comment:1 Changed 5 years ago by mattmcc

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

comment:2 Changed 5 years ago by russellm

  • Resolution set to wontfix
  • Status changed from new to closed

Marking wontfix because this doesn't have a specific call to action. "It should be better" is a catch all that applies to almost any documentation.

Feel free to reopen if you can provide either a specific list of topics that you think should be covered, or better still, a draft of some text that we can integrate.

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