add some docs on how to disable the use of memento

jeroendierckx · Aug 15, 2012 · 6781b5c · 6781b5c
1 parent 6c4989d
commit 6781b5c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/camelot/model/memento.py b/camelot/model/memento.py
@@ -22,8 +22,13 @@
 #
 #  ============================================================================
 
-"""Set of classes to keep track of changes to objects and be able to restore 
-their state
+"""The ORM part of the classes that store the change history of objects to
+the database.  The table defined here is used in :mod:`camelot.core.memento` 
+to store the changes.
+
+To prevent this table to be used to store changes, overwrite the 
+:meth:`camelot.admin.application_admin.ApplicationAdmin.get_memento` method
+the custom `ApplicationAdmin`.
 """
 
 import datetime

diff --git a/doc/sphinx/source/doc/data_model.rst b/doc/sphinx/source/doc/data_model.rst
@@ -4,7 +4,7 @@
   Built in data models
 ########################
 
-Camelot comes with a number of built in data models.  To avoid boiler platem odels needed in almost any application (like Persons, Addresses, etc.), 
+Camelot comes with a number of built in data models.  To avoid boiler plate models needed in almost any application (like Persons, Addresses, etc.), 
 the developer is encouraged to use these data models as a start for developing custom applications.
 
 To activate a model, the model should be imported in the `setup_model` method of `settings.py`::