#31591 closed Cleanup/optimization (fixed)
Spanning relationship backwards when related_name is used.
| Reported by: | Nat S Dunn | Owned by: | Carlton Gibson |
|---|---|---|---|
| Component: | Documentation | Version: | 3.0 |
| Severity: | Normal | Keywords: | related_name |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
Under https://docs.djangoproject.com/en/3.0/topics/db/queries/#lookups-that-span-relationships, the documentation says:
It works backwards, too. To refer to a “reverse” relationship, use the lowercase name of the model.
This works only if the name of that relationship hasn't been changed with related_name.
I suggest updating the doc to read:
It works backwards, too. To refer to a “reverse” relationship, use the lowercase name of the model, unless you have used related_name to override the name of the relationship, in which case you should use the related_name you have set.
Change History (3)
comment:1 by , 5 years ago
| Has patch: | set |
|---|---|
| Owner: | changed from to |
| Status: | new → assigned |
| Triage Stage: | Unreviewed → Accepted |
Version 0, edited 5 years ago by (next)
Note:
See TracTickets
for help on using tickets.
OK, yes. Good spot.
The docs should probably cross-reference https://docs.djangoproject.com/en/3.0/topics/db/queries/#following-relationships-backward here.
At the least it's lowercased +
_set, so correcting the examples to match the sample models at the top would probably also ease confusion.PR