[cleanup] Docstring fixes
authorSylvain Thénault <sylvain.thenault@logilab.fr>
Wed, 28 Sep 2016 16:21:09 +0200
changeset 1597 d39735336352
parent 1596 7868ca263be8
child 1606 e097834d5292
[cleanup] Docstring fixes
entities/profile_generation.py
--- a/entities/profile_generation.py	Wed Sep 28 16:19:56 2016 +0200
+++ b/entities/profile_generation.py	Wed Sep 28 16:21:09 2016 +0200
@@ -162,7 +162,7 @@
 
 
 class SEDA2ExportAdapter(EntityAdapter):
-    """Abstract base class for export of SEDA profile"""
+    """Abstract base class for export of SEDA profile."""
     __abstract__ = True
     __select__ = is_instance('SEDAArchiveTransfer')
     encoding = 'utf-8'
@@ -194,11 +194,14 @@
 
         Params:
 
-        * `name`, value for the 'name' attribute of the xsd:element
+        * `tag`, tag name of the element
 
         * `parent`, the parent etree node
 
-        * `attributes`, dictionary of attributes
+        * `attributes`, dictionary of attributes - may contain a special 'documentation' attribute
+          that will be added in a xsd:annotation node
+
+        * `text`, textual content of the tag if any
         """
         attributes = attributes or {}
         tag = self.qname(tag)
@@ -302,7 +305,7 @@
 
 
 class SEDA2XSDExport(SEDA2ExportAdapter):
-    """Adapter to build an XSD representation of a SEDA profile, using SEDA 2.0 specification"""
+    """Adapter to build an XSD representation of a SEDA profile, using SEDA 2.0 specification."""
     __regid__ = 'SEDA-2.0.xsd'
     extension = 'xsd'
     namespaces = {
@@ -496,7 +499,8 @@
 
 
 class SEDA2RelaxNGExport(SEDA2ExportAdapter):
-    """Adapter to build a Relax NG representation of a SEDA profile, using SEDA 2.0 specification"""
+    """Adapter to build a Relax NG representation of a SEDA profile, using SEDA 2.0 specification.
+    """
     __regid__ = 'SEDA-2.0.rng'
     extension = 'rng'