Opened 11 years ago

Closed 11 years ago

Last modified 11 years ago

#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)

19699.patch (1.1 KB ) - added by Aymeric Augustin 11 years ago.

Download all attachments as: .zip

Change History (8)

comment:1 by Rafal Stozek, 11 years ago

"Please see the release notes" is a standard text for every "version added" section. It is a bit misleading though.

comment:2 by Tim Graham, 11 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 Aymeric Augustin, 11 years ago

Triage Stage: UnreviewedAccepted
Type: UncategorizedCleanup/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 Aymeric Augustin, 11 years ago

Attachment: 19699.patch added

comment:4 by Aymeric Augustin, 11 years ago

Has patch: set

comment:5 by Tim Graham, 11 years ago

Triage Stage: AcceptedReady 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 Tim Graham <timograham@…>, 11 years ago

Resolution: fixed
Status: newclosed

In d93edffa896a68fc74c9a414c6beee289d176798:

Fixed #19699 - Removed "Please see the release notes" from versionadded/changed directives

Also bumped django_next_version back to 1.6 so those
annotations are described as "the development version"
in the docs.

Thanks Aymeric for the patch.

comment:7 by Tim Graham <timograham@…>, 11 years ago

In 7b278278ab66ddaba85b1a0604d6764005d29c70:

[1.5.x] Fixed #19699 - Removed "Please see the release notes" from versionadded/changed directives

Thanks Aymeric for the patch.

Backport of d93edffa89 from master.

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