src/pyams_viewlet/__init__.py
changeset 47 df022d00a9c4
parent 37 38ec13042956
--- a/src/pyams_viewlet/__init__.py	Fri Jan 18 15:32:56 2019 +0100
+++ b/src/pyams_viewlet/__init__.py	Wed Nov 27 15:57:21 2019 +0100
@@ -10,18 +10,26 @@
 # FOR A PARTICULAR PURPOSE.
 #
 
-__docformat__ = 'restructuredtext'
+"""PyAMS_viewlet package
+
+Viewlets provide a generic framework for building pluggable user interfaces.
+
+Generally speaking, viewlets managers are a special type of content providers, which are used
+inside a page layout to define "regions" into which other content providers called "viewlets"
+can be plugged.
+
+By using this approach, developers can extend PyAMS features by registering new components
+which will integrate easilly into default PyAMS layout; these viewlets are registered to be
+plugged into a specific viewlet manager, which "owns" its viewlets and is defined by a
+specific interface.
+"""
+
+from chameleon import PageTemplateFile
+from pyramid.i18n import TranslationStringFactory
+
+from pyams_viewlet.provider import ProviderExpr
 
 
-# import standard library
-
-# import interfaces
-
-# import packages
-from chameleon import PageTemplateFile
-from pyams_viewlet.provider import ProviderExpr
-
-from pyramid.i18n import TranslationStringFactory
 _ = TranslationStringFactory('pyams_viewlet')