Documented "rel objects".

Kept the docstring short because these objects aren't very well defined
and they're in the crosshairs of several refactorings.
This commit is contained in:
Aymeric Augustin 2015-09-20 21:55:46 +02:00
parent e542e81b39
commit 361254810e
1 changed files with 11 additions and 0 deletions

View File

@ -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