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 some more inline documentation

Browse source
This commit is contained in:
Jan-Jelle Kester 2013-10-23 17:23:52 +02:00
parent b66ada0baa
commit 18148f62c1
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
src/auditlog/models.py
View file

@ -44,7 +44,13 @@ class LogEntryManager(models.Manager):
class LogEntry(models.Model):
"""
Represents an entry in the audit log, containing data.
Represents an entry in the audit log. The content type is saved along with the textual and numeric (if available)
primary key, as well as the textual representation of the object when it was saved. It holds the action performed
and the fields that were changed in the transaction.
If AuditLogMiddleware is used, the actor will be set automatically. Keep in mind that editing / re-saving LogEntry
instances may set the actor to a wrong value - editing LogEntry instances is not recommended (and it should not be
necessary).
"""
class Action:
@ -92,6 +98,10 @@ class AuditLogHistoryField(generic.GenericRelation):
"""
A subclass of django.contrib.contenttypes.generic.GenericRelation that sets some default variables. This makes it
easier to implement the audit log in models, and makes future changes easier.
By default this field will assume that your primary keys are numeric, simply because this is the most common case.
However, if you have a non-integer primary key, you can simply pass pk_indexable=False to the constructor, and
Auditlog will fall back to using a non-indexed text based field for this model.
"""
def __init__(self, pk_indexable=True, **kwargs):