src/pyams_form/__init__.py
changeset 204 c435de184bda
parent 0 7a0b409fd4b8
--- a/src/pyams_form/__init__.py	Tue Nov 19 16:30:58 2019 +0100
+++ b/src/pyams_form/__init__.py	Wed Dec 04 11:05:25 2019 +0100
@@ -10,17 +10,23 @@
 # FOR A PARTICULAR PURPOSE.
 #
 
-__docformat__ = 'restructuredtext'
+"""PyAMS_form package
+
+This package is an extension to z3c.form.
+
+It allows to integrate z3c forms into Pyramid; it is adding some features like inner subforms
+(handled with adapters), form groups (which are ued to group form fields together inside a
+fieldset in a form), modal forms (which are displayed into a modal window), and is providing
+default templates for all these elements to be displayed correctly when using PyAMS_zmi package
+or any other Bootstrap-based skin.
+"""
+
+from pyramid.i18n import TranslationStringFactory
 
 
-# import standard library
-
-# import interfaces
+_ = TranslationStringFactory('pyams_form')
 
-# import packages
-
-from pyramid.i18n import TranslationStringFactory
-_ = TranslationStringFactory('pyams_form')
+__docformat__ = 'restructuredtext'
 
 
 def includeme(config):
@@ -28,5 +34,5 @@
 
     Split in another package to remove cyclic dependencies with TranslationStringFactory
     """
-    from .include import include_package
+    from .include import include_package  # pylint: disable=import-outside-toplevel
     include_package(config)