From 361254810eb8920978d69aa0fc074dbd40bfcc21 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 20 Sep 2015 21:55:46 +0200 Subject: [PATCH] Documented "rel objects". Kept the docstring short because these objects aren't very well defined and they're in the crosshairs of several refactorings. --- django/db/models/fields/reverse_related.py | 11 +++++++++++ 1 file changed, 11 insertions(+) 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