[Django] #28471: Clarify the documentation about the relationship between model meta "index_together" and "indexes" using Index() classes

[Django]

#28471: Clarify the documentation about the relationship between model meta
"index_together" and "indexes" using Index() classes
-------------------------------------+-------------------------------------
Reporter: Philippe | Owner: nobody
Ombredanne |
Type: Bug | Status: new
Component: Database | Version: 1.11
layer (models, ORM) | Keywords: documentation,
Severity: Normal | index, index_together
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
-------------------------------------+-------------------------------------
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.

--
Ticket URL: <https://code.djangoproject.com/ticket/28471>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#28471: Clarify the documentation about the relationship between model meta
"index_together" and "indexes" using Index() classes
-------------------------------------+-------------------------------------

Reporter: Philippe Ombredanne | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: 1.11
Severity: Normal | Resolution:
Keywords: documentation, | Triage Stage: Accepted
index, index_together |
Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Tim Graham):

* type: Bug => Cleanup/optimization
* component: Database layer (models, ORM) => Documentation
* easy: 1 => 0
* stage: Unreviewed => Accepted

--
Ticket URL: <https://code.djangoproject.com/ticket/28471#comment:1>

[Django]

#28471: Clarify the documentation about the relationship between model meta
"index_together" and "indexes" using Index() classes
-------------------------------------+-------------------------------------

Reporter: Philippe Ombredanne | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: 1.11
Severity: Normal | Resolution:
Keywords: documentation, | Triage Stage: Accepted
index, index_together |

Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Abhilash Rejanair):

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

--
Ticket URL: <https://code.djangoproject.com/ticket/28471#comment:2>

[Django]

#28471: Clarify the documentation about the relationship between model meta
"index_together" and "indexes" using Index() classes
-------------------------------------+-------------------------------------

Reporter: Philippe Ombredanne | Owner: nobody

Type: | Status: closed

Cleanup/optimization |
Component: Documentation | Version: 1.11

Severity: Normal | Resolution: fixed

Keywords: documentation, | Triage Stage: Accepted
index, index_together |

Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Tim Graham <timograham@…>):

* status: new => closed
* resolution: => fixed

Comment:

In [changeset:"d18227e341ed044980d02a1f65f3874166552ded" d18227e]:
{{{
#!CommitTicketReference repository=""
revision="d18227e341ed044980d02a1f65f3874166552ded"
Fixed #28471 -- Clarified that Meta.indexes is preferred to
index_together.
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/28471#comment:3>

[Django]

#28471: Clarify the documentation about the relationship between model meta
"index_together" and "indexes" using Index() classes
-------------------------------------+-------------------------------------

Reporter: Philippe Ombredanne | Owner: nobody
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: 1.11
Severity: Normal | Resolution: fixed
Keywords: documentation, | Triage Stage: Accepted
index, index_together |

Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Tim Graham <timograham@…>):

In [changeset:"479554f569abe5dbca980ac930fa1f474ef17c6e" 479554f5]:
{{{
#!CommitTicketReference repository=""
revision="479554f569abe5dbca980ac930fa1f474ef17c6e"
[1.11.x] Fixed #28471 -- Clarified that Meta.indexes is preferred to
index_together.

Backport of d18227e341ed044980d02a1f65f3874166552ded from master
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/28471#comment:4>