diff options
| author | Aymeric Augustin <aymeric.augustin@m4x.org> | 2015-09-20 21:55:46 +0200 |
|---|---|---|
| committer | Aymeric Augustin <aymeric.augustin@m4x.org> | 2015-09-21 22:20:42 +0200 |
| commit | 361254810eb8920978d69aa0fc074dbd40bfcc21 (patch) | |
| tree | d53d8261f6e5a0676b8d2637566dd3a68a638100 | |
| parent | e542e81b39e8610b70cf1d68f95ece0279028765 (diff) | |
Documented "rel objects".
Kept the docstring short because these objects aren't very well defined
and they're in the crosshairs of several refactorings.
| -rw-r--r-- | django/db/models/fields/reverse_related.py | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/django/db/models/fields/reverse_related.py b/django/db/models/fields/reverse_related.py index d47d40e42d..015fa02165 100644 --- a/django/db/models/fields/reverse_related.py +++ b/django/db/models/fields/reverse_related.py @@ -1,3 +1,14 @@ +""" +"Rel objects" for related fields. + +"Rel objects" (for lack of a better name) carry information about the relation +modeled by a related field and provide some utility functions. They're stored +in the ``remote_field`` attribute of the field. + +They also act as reverse fields for the purposes of the Meta API because +they're the closest concept currently available. +""" + from __future__ import unicode_literals import warnings |