Opened 9 years ago

Closed 9 years ago

#5357 closed (fixed)

Documentation should include page argument of object_list

Reported by: Brian Morton <rokclimb15@…> Owned by: mitja
Component: Documentation Version: master
Severity: Keywords: object_list, page, pagination, sprintsept14
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: yes
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

Currently, the generic view documentation at http://www.djangoproject.com/documentation/generic_views/#django-views-generic-list-detail-object-list makes no mention of the page keyword argument, which is the current page being viewed. This is transparent if you are calling object_list from the urlconf, since the view receives this argument on its own. However, if you are writing a wrapper around object_list, it is important to know that it accepts the page argument since you must intercept it and pass it yourself. Otherwise the view will not function properly with pagination.

Attachments (1)

generic_views_r6243.diff (832 bytes) - added by mitja 9 years ago.
Adds documentation for page argument against r6243

Download all attachments as: .zip

Change History (9)

comment:1 Changed 9 years ago by Simon G. <dev@…>

Needs documentation: set
Triage Stage: UnreviewedAccepted

comment:2 Changed 9 years ago by flother

Resolution: duplicate
Status: newclosed

Marked as duplicate as this was patched in #4330 and fixed in [5293].

comment:3 Changed 9 years ago by flother

Resolution: duplicate
Status: closedreopened

Oops, that last comment was meant for #3757. Reopened.

comment:4 Changed 9 years ago by Nick Efford

Owner: changed from nobody to Nick Efford
Status: reopenednew

comment:5 Changed 9 years ago by mitja

Owner: changed from Nick Efford to mitja
Status: newassigned

Changed 9 years ago by mitja

Attachment: generic_views_r6243.diff added

Adds documentation for page argument against r6243

comment:6 Changed 9 years ago by mitja

Has patch: set
Keywords: sprintsept14 added

comment:7 Changed 9 years ago by James Bennett

Triage Stage: AcceptedReady for checkin

Patch looks good to me.

comment:8 Changed 9 years ago by Russell Keith-Magee

Resolution: fixed
Status: assignedclosed

(In [6280]) Fixed #5357 -- Added documentation on the 'page' argument to generic object_list views. Thanks, mitja.

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