Opened 5 years ago

Closed 5 years ago

Last modified 3 years ago

#14147 closed Uncategorized (fixed)

django 1.2 documentation refer to assertQuerysetEqual which is only available in trunk

Reported by: djoume Owned by: nobody
Component: Documentation Version: 1.2
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

http://docs.djangoproject.com/en/1.2/topics/testing/#assertions describes TestCase.assertQuerysetEqual which is not available in 1.2 because it has been added in [13309] and django 1.2.1 has been tagged from trunk in [13302] http://code.djangoproject.com/log/django/tags/releases/1.2.1

Attachments (1)

assertquerysetequal_doc.diff (508 bytes) - added by djoume 5 years ago.

Download all attachments as: .zip

Change History (9)

comment:1 Changed 5 years ago by ramiro

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

The docs published under /en/1.2/ aren't rendered from a frozen copy of the tree (e.g. the last release from the bug fix-only releases/1.2.X SVN branch) but from an always current checkout of its tip.

That branch was created in r13361. All the commits between r13285 (the moment 1.2 got tagged) and r13361 are present both in trunk and in the 1.2.X branch.

So the new assertQuerysetEqual() method will be available in the 1.2 series starting with 1.2.2.

comment:2 Changed 5 years ago by djoume

  • Component changed from Uncategorized to Documentation
  • Has patch set
  • Triage Stage changed from Unreviewed to Ready for checkin

Fair enough. The attached patch add a "New in Django 1.2" to the assertQuerysetEqual documentation

Changed 5 years ago by djoume

comment:3 Changed 5 years ago by russellm

  • milestone set to 1.3

If we follow the backwards compatibility policy strictly, we can't introduce a new feature into 1.2; also, the feature doesn't (and can't) exist in Django 1.2.0 or 1.2.1. It will appear in 1.2.2, by virtue of a backported test case.

Strictly by the book, we should revert the changesets that need to use assertQuerysetEqual. However, the overhead of maintaining two different test suites (plus the speed boost associated with moving to unit tests) is too much to ignore.

In the interests of practicality, I'm going to mark this as a "new in 1.3" feature; it will exist as a feature in 1.2, but it will be a stealth feature, and won't be documented.

comment:4 Changed 5 years ago by russellm

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

(In [13624]) Fixed #14147 -- Added documentation metadata for new assertQuerysetEqual test method. Thanks to djoume for the report.

comment:5 Changed 5 years ago by russellm

(In [13625]) [1.2.X] Fixed #14147 -- Added documentation metadata for new assertQuerysetEqual test method. Thanks to djoume for the report.

Backport of r13624 from trunk.

comment:6 Changed 4 years ago by jacob

  • milestone 1.3 deleted

Milestone 1.3 deleted

comment:7 follow-up: Changed 3 years ago by codysomerville

  • Easy pickings unset
  • Severity set to Normal
  • Type set to Uncategorized
  • UI/UX unset

For what it's worth, it is confusing that the documentation is inaccurate.

comment:8 in reply to: ↑ 7 Changed 3 years ago by carljm

Replying to codysomerville:

For what it's worth, it is confusing that the documentation is inaccurate.

Hi Cody - I'm confused about what is inaccurate/confusing in the documentation. The documentation bug reported here is fixed; if you think there's still a bug in the docs, please report it in a new ticket. Thanks!

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