Changeset 13146 for main/waeup.ikoba/trunk/src

Timestamp:

7 Jul 2015, 05:43:23 (9 years ago)

Author:

Henrik Bettermann

Message:

Prepare some docstrings for Sphinx docu.

Location:

main/waeup.ikoba/trunk/src/waeup/ikoba/documents

Files:

• batching.py (modified) (1 diff)
• browser_templates/htmldocumentpage.pt (modified) (1 diff)
• export.py (modified) (2 diffs)

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/batching.py

@@ -43 +43 @@
 
 class DocumentProcessorBase(BatchProcessor):
-    """A base for batch processors for IDocument objects.
+    """This is the base class for all kinds of document processors.
+    The `checkConversion` method checks whether `class_name` in a row
+    corresponds with the processor chosen. This is to avoid accidentally
+    wrong imports.
+
+    Document processors do not import workflow states or transitions which
+    means, all imported documents will be unpublished after batch creation.
+    In other words, publishing can't be done by import, it has do be done
+    via the UI.
     """
     grok.implements(IBatchProcessor)

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/browser_templates/htmldocumentpage.pt

@@ -35 +35 @@
       </td>
       <td>
-        &lt;a href=&quot;
-        <span tal:replace="python: view.url(context, 'display')"></span>
-        &quot;&gt;<span tal:replace="context/title">FILENAME</span>&lt;/a&gt;
+        &lt;a href=&quot;<span tal:replace="python: view.url(context, 'display')"></span>&quot;&gt;<span tal:replace="context/title">
+        FILENAME
+        </span>&lt;/a&gt;
       </td>
     </tr>

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/export.py

@@ -29 +29 @@
 
 class DocumentExporterBase(grok.GlobalUtility, ExporterBase):
-    """Exporter for documents.
+    """This is the exporter base class for all kinds of document exporters.
+    Derived classes export all documents of type `class_name` inside the
+    documents container.
+
+    All schema fields and the property attributes
+    `history`, `state`, `class_name` and `users_with_local_roles`
+    are being exported.
     """
     grok.implements(ICSVExporter)
@@ -54 +60 @@
 
     def mangle_value(self, value, name, context=None):
-        """Hook for mangling values in derived classes
+        """The mangler prepares the history messages and computes the
+        `users_with_local_roles` value which is a Python expression like:
+
+        ``[{'user_name': u'bob', 'local_role': u'bobsrole'},
+        {'user_name': u'anna', 'local_role': u'annasrole'}]``
         """
         if name == 'users_with_local_roles':