소스 검색

RevisionsIntegrity: Add comment

Bastien Sevajol 9 년 전
부모
커밋
f92689d5b8
1개의 변경된 파일8개의 추가작업 그리고 0개의 파일을 삭제
  1. 8 0
      tracim/tracim/model/__init__.py

+ 8 - 0
tracim/tracim/model/__init__.py 파일 보기

@@ -11,6 +11,14 @@ from tracim.lib.exception import ContentRevisionUpdateError, ContentRevisionDele
11 11
 
12 12
 
13 13
 class RevisionsIntegrity(object):
14
+    """
15
+    Simple static used class to manage a list with list of ContentRevisionRO who are allowed to be updated.
16
+
17
+    When modify an already existing (understood have an identity in databse) ContentRevisionRO, if it's not in
18
+    RevisionsIntegrity._updatable_revisions list, a ContentRevisionUpdateError thrown.
19
+
20
+    This class is used by tracim.model.new_revision context manager.
21
+    """
14 22
     _updatable_revisions = []
15 23
 
16 24
     @classmethod