Opened 10 years ago

Closed 10 years ago

#24458 closed Cleanup/optimization (worksforme)

Documentation often overlooks class-based views

Reported by: Daniel Quinn Owned by: Daniel Quinn
Component: Documentation Version: 1.7
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

Change History (6)

comment:1 by Daniel Quinn, 10 years ago

Owner: changed from nobody to Daniel Quinn
Status: newassigned

comment:2 by Tim Graham, 10 years ago

Triage Stage: UnreviewedAccepted
Type: UncategorizedCleanup/optimization

Hopefully we can do this in a way that doesn't require two examples for every case. Maybe a more general "translating between function and class-based views" overview would be useful.

in reply to:  2 comment:3 by Daniel Quinn, 10 years ago

I agree, this would be preferable. Should it just be an addendum to the existing "Class Based Views" page, or something separate?

comment:4 by Daniel Quinn, 10 years ago

Actually, now that I look at the CBV docs, there appears to be everything covered there, it just wasn't immediately obvious from the URLs above where I needed to look to do things like use @login_required in a CBV. Maybe it's just a question of prioritising function-based over class-based, and that's fine if that's the case, but some way to point to these docs when referencing things like decorators would be handy.

comment:5 by Tim Graham, 10 years ago

Yea, not sure. It seems a bit annoying to link to that doc on every decorator, but maybe it could be done tastefully.

comment:6 by Tim Graham, 10 years ago

Resolution: worksforme
Status: assignedclosed

Feel free to reopen if you want to provide a patch. Not sure it's terribly high priority.

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