#36095 closed Cleanup/optimization (fixed)
Explicitly introduce lazy references in early sections of the docs before they are used.
| Reported by: | Clifford Gama | Owned by: | Clifford Gama |
|---|---|---|---|
| Component: | Documentation | Version: | 5.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
While reading https://docs.djangoproject.com/en/dev/topics/db/models/, I noticed two issues:
- Lazy relationships are used in the documentation before they are explicitly introduced https://docs.djangoproject.com/en/dev/topics/db/models/#extra-fields-on-many-to-many-relationships
- The
ManyToManyField.throughoption does not document that it supports lazy references.
To address these:
For the first issue, I propose explicitly introducing lazy references in the introductory Models across files section.
For the second issue, I propose adding a note to the ManyToManyField.through section, clarifying that it supports both lazy references and direct model classes.
Change History (9)
comment:1 by , 9 months ago
| Has patch: | set |
|---|
comment:2 by , 9 months ago
| Triage Stage: | Unreviewed → Accepted |
|---|
comment:3 by , 6 months ago
| Triage Stage: | Accepted → Ready for checkin |
|---|
Note:
See TracTickets
for help on using tickets.
PR