Opened 5 years ago

Closed 5 years ago

Last modified 4 years ago

#14232 closed (fixed)

date_list context variable incorrectly documented

Reported by: clelland Owned by: anonymous
Component: Documentation Version: master
Severity: Keywords: date_list generic views
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

The 'date_list' context variable, provided by django.views.generic.date_based.archive_year and .archive_month, is documented as being a list of datetime.date objects. In fact, it is a DateQuerySet, which in at least some circumstances, behaves quite differently.

I believe that the behaviour, as implemented, is correct, and that this is simply a documentation issue. I have attached a patch which, I believe, clarifies the situation.

Attachments (1)

date_list_documentation_patch.diff (2.1 KB) - added by clelland 5 years ago.

Download all attachments as: .zip

Change History (5)

Changed 5 years ago by clelland

comment:1 Changed 5 years ago by anonymous

  • Needs documentation unset
  • Needs tests unset
  • Owner changed from nobody to anonymous
  • Patch needs improvement unset
  • Status changed from new to assigned
  • Triage Stage changed from Unreviewed to Ready for checkin

comment:2 Changed 5 years ago by russellm

  • Resolution set to fixed
  • Status changed from assigned to closed

(In [14020]) Fixed #14232 -- Clarified the data type of date_list in date-based generic views. Thanks to clelland for the report and patch.

comment:3 Changed 5 years ago by russellm

(In [14028]) [1.2.X] Fixed #14232 -- Clarified the data type of date_list in date-based generic views. Thanks to clelland for the report and patch.

Backport of r14020 from trunk.

comment:4 Changed 4 years ago by jacob

  • milestone 1.3 deleted

Milestone 1.3 deleted

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