Opened 6 years ago

Closed 6 years ago

Last modified 6 years ago

#14225 closed (fixed)

Documentation website showing "dev" documentation instead of "1.2"

Reported by: public@… Owned by: nobody
Component: Documentation Version: master
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

On the documentation website, the "1.2" pages actually show the "dev" documentation. This can be verified by searching for the string "enforce_csrf_checks" in the dev and 1.2 documentation pages for the CSRF protection feature (the argument to Client was added in r13640).

Change History (6)

comment:1 Changed 6 years ago by Luke Plant

Resolution: invalid
Status: newclosed

That feature was backported to the 1.2.X branch in [13642] (not absolutely sure why, but it was anyway). I've checked some other pages and the 1.2 section is showing the 1.2.X branch as it should, not trunk.

comment:2 Changed 6 years ago by alex_morega

Right, it makes sense. But still it's confusing to read documentation for an unreleased version, I think the 1.2 documentation should reflect the latest release, 1.2.1.

comment:3 Changed 6 years ago by Russell Keith-Magee

Component: Django Web siteDocumentation
Resolution: invalid
Status: closedreopened
Triage Stage: UnreviewedAccepted

For historical completeness; it was backported because it was required for a test case that *did* need to be backported to 1.2.

Thinking about it some more, we have precedent here; The CSRF template tag is marked "new in Django 1.1.2"; This was equally confusing in the period between the introduction of the feature and the release of 1.1.2 (since the docs refer to a release that isn't available), but it is probably less confusing than not referencing a version at all.

Reopening on that basis.

comment:4 Changed 6 years ago by alex_morega

Perhaps the docs for each branch should say "new in 1.1.2" and "new in 1.2.2", depending on the version when they will be released on that branch? Maybe even with a link to a page for that version number, which will either say "released at date X" or "not released yet".

comment:5 Changed 6 years ago by Russell Keith-Magee

Resolution: fixed
Status: reopenedclosed

(In [14011]) Fixed #14225 -- Added a documentation marker (and a 1.2.2 release notes file, required to satisfy Sphinx) for the enable_csrf_checks flag on the test client. Thanks to public@… for the report.

comment:6 Changed 6 years ago by Russell Keith-Magee

(In [14022]) [1.2.X] Fixed #14225 -- Added a documentation marker (and a 1.2.2 release notes file, required to satisfy Sphinx) for the enable_csrf_checks flag on the test client. Thanks to public@… for the report.

Backport of r14011 from trunk.

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