Hopiu/django-auditlog
1
0
Fork 0
mirror of https://github.com/jazzband/django-auditlog.git synced 2026-03-16 22:20:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Add South compatibility to docs

Browse source
This commit is contained in:
Jan-Jelle Kester 2014-07-08 17:34:12 +02:00
parent 9fcd63f1dd
commit 4606f614a8
1 changed files with 13 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/source/usage.rst
View file

@ -38,12 +38,17 @@ project's configuration file::
It is recommended to keep all middleware that alters the request loaded before Auditlog's middleware. It is recommended to keep all middleware that alters the request loaded before Auditlog's middleware.
Please keep in mind that every object change in a request that gets logged automatically will have the current request's .. warning::
user as actor.
Please keep in mind that every object change in a request that gets logged automatically will have the current request's
user as actor. To only have some object changes to be logged with the current request's user as actor manual logging is
required.
Object history Object history
-------------- --------------
.. py:currentmodule:: auditlog.models
Auditlog ships with a custom field that enables you to easily get the log entries that are relevant to your object. This Auditlog ships with a custom field that enables you to easily get the log entries that are relevant to your object. This
functionality is built on Django's content types framework (``django.contrib.contenttypes``). Using this field in your functionality is built on Django's content types framework (``django.contrib.contenttypes``). Using this field in your
models is equally easy as any other field:: models is equally easy as any other field::
@ -58,6 +63,10 @@ models is equally easy as any other field::
auditlog.register(MyModel) auditlog.register(MyModel)
``AuditlogHistoryField`` accepts an optional ``pk_indexable`` parameter, which is either ``True`` or ``False``, this :py:class:`AuditlogHistoryField` accepts an optional :py:attr:`pk_indexable` parameter, which is either ``True`` or ``False``, this
defaults to ``True``. If your model has a custom primary key that is not an integer value, ``pk_indexable`` needs to be defaults to ``True``. If your model has a custom primary key that is not an integer value, :py:attr:`pk_indexable` needs to be
set to ``False``. Keep in mind that this might slow down queries. set to ``False``. Keep in mind that this might slow down queries.
.. versionadded:: 0.2.1
South compatibility for :py:class:`AuditlogHistoryField`