[Django] #23528: django.db.migrations.swappable_dependency not documented

[Django]

#23528: django.db.migrations.swappable_dependency not documented
-----------------------------------------+----------------------------
Reporter: shaib | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: 1.7
Severity: Normal | Keywords: migrations
Triage Stage: Accepted | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-----------------------------------------+----------------------------
As far as I could see, `django.db.migrations.swappable_dependency` (which
is used in migrations whenever the operations need to create a FK to a
swappable model) is not documented at all. It needs to be documented
because, although it usually shows up in generated code, that code is
considered as user-code and should be possible to write by hand as well.

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

[Django]

#23528: django.db.migrations.swappable_dependency not documented
-------------------------------+------------------------------------
Reporter: Shai Berger | Owner: nobody

Type: Bug | Status: new
Component: Documentation | Version: 1.7

Severity: Normal | Resolution:

Keywords: migrations | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------+------------------------------------
Changes (by Sergey Fedoseev):

* cc: Sergey Fedoseev (added)

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

[Django]

#23528: django.db.migrations.swappable_dependency not documented
-------------------------------+------------------------------------

Reporter: Shai Berger | Owner: nobody

Type: Bug | Status: new
Component: Documentation | Version: 1.7

Severity: Normal | Resolution:

Keywords: migrations | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------+------------------------------------
Changes (by Natt Piyapramote):

* cc: Natt Piyapramote (added)

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

[Django]

#23528: django.db.migrations.swappable_dependency not documented
-------------------------------+------------------------------------

Reporter: Shai Berger | Owner: Bhuvnesh
Type: Bug | Status: assigned
Component: Documentation | Version: 1.7
Severity: Normal | Resolution:

Keywords: migrations | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------+------------------------------------
Changes (by Bhuvnesh):

* owner: nobody => Bhuvnesh
* status: new => assigned

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

[Django]

#23528: django.db.migrations.swappable_dependency not documented
-------------------------------+------------------------------------
Reporter: Shai Berger | Owner: Bhuvnesh
Type: Bug | Status: assigned

Component: Documentation | Version: 1.7
Severity: Normal | Resolution:

Keywords: migrations | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------+------------------------------------
Changes (by Sergey Fedoseev):

* cc: Sergey Fedoseev (removed)

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

[Django]

#23528: django.db.migrations.swappable_dependency not documented
-------------------------------+------------------------------------
Reporter: Shai Berger | Owner: Bhuvnesh
Type: Bug | Status: assigned

Component: Documentation | Version: 1.7
Severity: Normal | Resolution:

Keywords: migrations | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------+------------------------------------
Changes (by Mariusz Felisiak):

* has_patch: 0 => 1

Comment:

[https://github.com/django/django/pull/16861 PR]

--
Ticket URL: <https://code.djangoproject.com/ticket/23528#comment:5>

[Django]

#23528: django.db.migrations.swappable_dependency not documented
-------------------------------+------------------------------------
Reporter: Shai Berger | Owner: Bhuvnesh
Type: Bug | Status: assigned

Component: Documentation | Version: 1.7
Severity: Normal | Resolution:

Keywords: migrations | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0

-------------------------------+------------------------------------
Changes (by Mariusz Felisiak):

* needs_better_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/23528#comment:6>

[Django]

#23528: django.db.migrations.swappable_dependency not documented
-------------------------------+------------------------------------
Reporter: Shai Berger | Owner: Bhuvnesh
Type: Bug | Status: assigned

Component: Documentation | Version: 1.7
Severity: Normal | Resolution:

Keywords: migrations | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------+------------------------------------
Changes (by Mariusz Felisiak):

* needs_better_patch: 1 => 0

--
Ticket URL: <https://code.djangoproject.com/ticket/23528#comment:7>

[Django]

#23528: django.db.migrations.swappable_dependency not documented
-------------------------------+------------------------------------
Reporter: Shai Berger | Owner: Bhuvnesh
Type: Bug | Status: assigned

Component: Documentation | Version: 1.7
Severity: Normal | Resolution:

Keywords: migrations | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0

-------------------------------+------------------------------------
Changes (by Mariusz Felisiak):

* needs_better_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/23528#comment:8>

[Django]

#23528: django.db.migrations.swappable_dependency not documented
-------------------------------------+-------------------------------------

Reporter: Shai Berger | Owner: Bhuvnesh
Type: Bug | Status: assigned

Component: Documentation | Version: 1.7
Severity: Normal | Resolution:
Keywords: migrations | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak):

* needs_better_patch: 1 => 0
* stage: Accepted => Ready for checkin

--
Ticket URL: <https://code.djangoproject.com/ticket/23528#comment:9>

[Django]

#23528: django.db.migrations.swappable_dependency not documented
-------------------------------------+-------------------------------------
Reporter: Shai Berger | Owner: Bhuvnesh

Type: Bug | Status: closed
Component: Documentation | Version: 1.7
Severity: Normal | Resolution: fixed

Keywords: migrations | Triage Stage: Ready for
| checkin

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak <felisiak.mariusz@…>):

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

Comment:

In [changeset:"7d96ce68ae2c1bab1f2ab64ddc2b2c6004278af0" 7d96ce68]:
{{{
#!CommitTicketReference repository=""
revision="7d96ce68ae2c1bab1f2ab64ddc2b2c6004278af0"
Fixed #23528 -- Doc'd django.db.migrations.swappable_dependency().
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/23528#comment:10>

[Django]

#23528: django.db.migrations.swappable_dependency not documented
-------------------------------------+-------------------------------------
Reporter: Shai Berger | Owner: Bhuvnesh
Type: Bug | Status: closed

Component: Documentation | Version: 1.7

Severity: Normal | Resolution: fixed
Keywords: migrations | Triage Stage: Ready for
| checkin

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------

Comment (by Mariusz Felisiak <felisiak.mariusz@…>):

In [changeset:"92ad551afd51d0d3691ed5c83cf46c656664b1e5" 92ad551]:
{{{
#!CommitTicketReference repository=""
revision="92ad551afd51d0d3691ed5c83cf46c656664b1e5"
[4.2.x] Fixed #23528 -- Doc'd django.db.migrations.swappable_dependency().

Backport of 7d96ce68ae2c1bab1f2ab64ddc2b2c6004278af0 from main
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/23528#comment:11>

[Django]

#23528: django.db.migrations.swappable_dependency not documented
-------------------------------------+-------------------------------------
Reporter: Shai Berger | Owner: Bhuvnesh
Type: Bug | Status: closed

Component: Documentation | Version: 1.7

Severity: Normal | Resolution: fixed
Keywords: migrations | Triage Stage: Ready for
| checkin

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------

Comment (by GitHub <noreply@…>):

In [changeset:"1136aa5005f0ae70fea12796b7e37d6f027b9263" 1136aa50]:
{{{
#!CommitTicketReference repository=""
revision="1136aa5005f0ae70fea12796b7e37d6f027b9263"
Refs #23528 -- Made cosmetic edits to swappable_dependency() docs.
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/23528#comment:12>

[Django]

#23528: django.db.migrations.swappable_dependency not documented
-------------------------------------+-------------------------------------
Reporter: Shai Berger | Owner: Bhuvnesh
Type: Bug | Status: closed

Component: Documentation | Version: 1.7

Severity: Normal | Resolution: fixed
Keywords: migrations | Triage Stage: Ready for
| checkin

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------

Comment (by Mariusz Felisiak <felisiak.mariusz@…>):

In [changeset:"66d9fa43718461de1d083650a4fee1b16ba80f91" 66d9fa4]:
{{{
#!CommitTicketReference repository=""
revision="66d9fa43718461de1d083650a4fee1b16ba80f91"
[4.2.x] Refs #23528 -- Made cosmetic edits to swappable_dependency() docs.

Backport of 1136aa5005f0ae70fea12796b7e37d6f027b9263 from main
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/23528#comment:13>