Commit 36125481 authored by Aymeric Augustin's avatar Aymeric Augustin
Browse files

Documented "rel objects".

Kept the docstring short because these objects aren't very well defined
and they're in the crosshairs of several refactorings.
parent e542e81b
Loading
Loading
Loading
Loading
+11 −0
Original line number Diff line number Diff line
"""
"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