#36095: Explicitly introduce lazy references in early sections of the docs
before
they are used.
-------------------------------------+-------------------------------------
Reporter: Clifford | Owner: Clifford Gama
Gama |
Type: | Status: assigned
Cleanup/optimization |
Component: | Version: 5.1
Documentation |
Severity: Normal | Keywords:
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
While reading https://docs.djangoproject.com/en/dev/topics/db/models/, I
noticed two issues:
1. 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
2. The `ManyToManyField.through` option does not document that it supports
lazy references.
To address these:
For the first issue, I propose explicitly introducing lazy references in
the introductory [https://docs.djangoproject.com/en/dev/topics/db/models
/#models-across-files 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.
--
Ticket URL: <https://code.djangoproject.com/ticket/36095>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion visit
https://groups.google.com/d/msgid/django-updates/01070194611465dd-7f31dec6-1bfc-4727-8723-9a6307be3555-000000%40eu-central-1.amazonses.com.
