Note importance of setter for user recording

jazzband · Feb 7, 2014 · 5f40555 · 5f40555
1 parent 19d4069
commit 5f40555
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/docs/advanced.rst b/docs/advanced.rst
@@ -91,3 +91,5 @@ referencing the ``changed_by`` field:
         @_history_user.setter
         def _history_user(self, value):
             self.changed_by = value
+
+Admin integration requires that you use a ``_history_user.setter`` attribute with your custom ``_history_user`` property (see :ref:`admin_integration`).
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -44,6 +44,7 @@ Django tutorial:
 Now all changes to ``Poll`` and ``Choice`` model instances will be tracked in
 the database.
 
+.. _admin_integration:
 
 Integration with Django Admin
 -----------------------------