#19699 closed Cleanup/optimization (fixed)
Documentation for "index_together" is an infinite loop.
Reported by: | Vernon Cole | Owned by: | nobody |
---|---|---|---|
Component: | Documentation | Version: | 1.5-beta-1 |
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
The documintation in the 1.5 Release Notes reads:
Multi-column indexes can now be created on models. Read the index_together documentation for more information.
Following the link on "index_together" gets to this:
Options.index_together New in Django 1.5: Please see the release notes Sets of field names that, taken together, are indexed: index_together = [ ["pub_date", "deadline"], ] This list of fields will be indexed together (i.e. the appropriate CREATE INDEX statement will be issued.)
where the "release notes" link takes you back to the first instance...
Attachments (1)
Change History (8)
comment:1 by , 12 years ago
comment:2 by , 12 years ago
In my experience, the "Please see the release notes" link isn't very useful because it doesn't link to a specific section of the release notes and anything important that's mentioned in the release notes should also be included in the docs itself. I'd be +1 to removing these auto-generated links from the versionadded/versionchanged annotations.
comment:3 by , 12 years ago
Triage Stage: | Unreviewed → Accepted |
---|---|
Type: | Uncategorized → Cleanup/optimization |
I've also observed they're quite unhelpful.
Usually, the paragraph just above or below the annotation has more information than the release notes, which point back to that paragraph.
by , 12 years ago
Attachment: | 19699.patch added |
---|
comment:4 by , 12 years ago
Has patch: | set |
---|
comment:5 by , 12 years ago
Triage Stage: | Accepted → Ready for checkin |
---|
Looks good to me, although I noticed django_next_version in docs/conf.py is set to 1.7 which seems incorrect (I'd expect it to be 1.6).
comment:6 by , 12 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
"Please see the release notes" is a standard text for every "version added" section. It is a bit misleading though.