summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaulo <commonzenpython@gmail.com>2016-06-06 19:06:22 -0400
committerTim Graham <timograham@gmail.com>2016-06-07 07:22:32 -0400
commit3e9f769fd1ae91f0accdfa5e3d8e6f4600517872 (patch)
tree7e5b9e4612036ed1b611e310623eb8c22e03e7dc
parent31a9a965a36c5ce923692e5dac430ea6a1cbf2a0 (diff)
Refs #15250 -- Added docstring for ForwardOneToOneDescriptor.
-rw-r--r--django/db/models/fields/related_descriptors.py12
1 files changed, 11 insertions, 1 deletions
diff --git a/django/db/models/fields/related_descriptors.py b/django/db/models/fields/related_descriptors.py
index 82610508c6..b370e5c18e 100644
--- a/django/db/models/fields/related_descriptors.py
+++ b/django/db/models/fields/related_descriptors.py
@@ -78,7 +78,7 @@ from django.utils.functional import cached_property
class ForwardManyToOneDescriptor(object):
"""
Accessor to the related object on the forward side of a many-to-one or
- one-to-one relation.
+ one-to-one (via ForwardOneToOneDescriptor subclass) relation.
In the example::
@@ -265,6 +265,16 @@ class ForwardManyToOneDescriptor(object):
class ForwardOneToOneDescriptor(ForwardManyToOneDescriptor):
+ """
+ Accessor to the related object on the forward side of a one-to-one relation.
+
+ In the example::
+
+ class Restaurant(Model):
+ place = OneToOneField(Place, related_name='restaurant')
+
+ ``restaurant.place`` is a ``ForwardOneToOneDescriptor`` instance.
+ """
def get_object(self, instance):
if self.field.remote_field.parent_link: