Merge branch 'cabinet-search-result-documentation' into 'master'

Add documentation to CabinetSearchResult class See merge request mayan-edms/mayan-edms!83
tjikaljedy · May 11, 2020 · 802abeb · 802abeb
2 parents b3a2cc6 + 8d42269
commit 802abeb
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/mayan/apps/cabinets/models.py b/mayan/apps/cabinets/models.py
@@ -159,6 +159,11 @@ def validate_unique(self, exclude=None):
 
 
 class CabinetSearchResult(Cabinet):
+    """
+    Represent a cabinet's search result. This model is a proxy model from
+    Cabinet and is used as an alias to map columns to it without having to
+    map them to the base Cabinet model.
+    """
     class Meta:
         proxy = True
         verbose_name = _('Cabinet')