OneToOneField reference does not document the "reverse" name
|Reported by:||bjb@…||Owned by:||schacki|
|Has patch:||yes||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||yes|
Says OneToOneField is like ForeignKey, and does not name the reverse attribute.
ForeignKey states that the reverse attribute is called <othermodel>_set and can refer to multiple models. The OneToOneField documentation says the reverse attribute returns a single object, but doesn't say what the reverse name is (surely not <othermodel>_set? - but if not that, then what?)
This is true for 1.5 and dev documentation - probably true for other versions as well.
It would also be nice it if explicitly stated that an instance of the other model can exist without having an instance of the model that refers to it with OneToOneField. Eg, if you have:
place = OneToOneField (Place)
Then you can have a place record without a Restaurant record, but you cannot have a Restaurant record without a Place record. This is alluded to in the Place/Restaurant example elsewhere https://docs.djangoproject.com/en/dev/topics/db/examples/one_to_one/, but could be stated in the OneToOneField documentation.
This may be related to #10227. But until any change are implemented, I'm for documenting the actual behaviour.
Change History (7)
comment:1 Changed 2 years ago by timo
- Easy pickings set
- Needs documentation unset
- Needs tests unset
- Patch needs improvement unset
- Triage Stage changed from Unreviewed to Accepted
- Version changed from 1.5 to master
comment:4 Changed 2 years ago by schacki
- Owner changed from nobody to schacki
- Status changed from new to assigned
comment:5 Changed 2 years ago by Tim Graham <timograham@…>
- Resolution set to fixed
- Status changed from assigned to closed