src/pyams_utils/__init__.py
changeset 367 2c95d34496f5
parent 292 b338586588ad
child 387 604807051f00
--- a/src/pyams_utils/__init__.py	Wed Jun 12 20:06:45 2019 +0200
+++ b/src/pyams_utils/__init__.py	Fri Jun 14 12:41:06 2019 +0200
@@ -10,14 +10,16 @@
 # FOR A PARTICULAR PURPOSE.
 #
 
+"""PyAMS_utils package
+
+This package provides several small modules dedicated to generic features
+for which dedicated packages are not provided. These features can concern
+date and times management, strings and unicode, lists and dictionaries,
+custom decorators to define several kinds of properties, and so on.
+"""
+
 __docformat__ = 'restructuredtext'
 
-
-# import standard library
-
-# import interfaces
-
-# import packages
 from zope.schema.fieldproperty import FieldProperty
 
 from pyramid.i18n import TranslationStringFactory
@@ -25,6 +27,7 @@
 
 
 def get_field_doc(self):
+    """Try to get FieldProperty field docstring from field interface"""
     field = self._FieldProperty__field
     if field.title and field.description:
         return '{0}: {1}'.format(field.title, field.description)