Opened 7 years ago

Closed 7 years ago

Last modified 7 years ago

#28471 closed Cleanup/optimization (fixed)

Clarify the documentation about the relationship between model meta "index_together" and "indexes" using Index() classes

Reported by: Philippe Ombredanne Owned by: nobody
Component: Documentation Version: 1.11
Severity: Normal Keywords: documentation, index, index_together
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

Both are documented side by side with no indication of what is the difference of preferred way to use (especially since per #27236 "index_together" may be deprecated in the future).
The documentation should be enhanced to clarify which to use preferrably and what are the differences if any.

Change History (4)

comment:1 by Tim Graham, 7 years ago

Component: Database layer (models, ORM) → Documentation
Easy pickings: unset
Triage Stage: Unreviewed → Accepted
Type: Bug → Cleanup/optimization

comment:2 by Abhilash Rejanair, 7 years ago

Created a pull request adding more clarity to the documentation: ​https://github.com/django/django/pull/8863

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

Resolution: → fixed
Status: new → closed

In d18227e:

Fixed #28471 -- Clarified that Meta.indexes is preferred to index_together.

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

In 479554f5:

[1.11.x] Fixed #28471 -- Clarified that Meta.indexes is preferred to index_together.

Backport of d18227e341ed044980d02a1f65f3874166552ded from master

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