src/pyams_pagelet/__init__.py
changeset 12 fc3542685741
parent 1 b90ce037f872
--- a/src/pyams_pagelet/__init__.py	Mon Jun 11 17:30:43 2018 +0200
+++ b/src/pyams_pagelet/__init__.py	Wed Nov 27 19:37:28 2019 +0100
@@ -10,8 +10,19 @@
 # FOR A PARTICULAR PURPOSE.
 #
 
+"""PyAMS_pagelet package
+
+This package is an update of z3c.pagelet package for use with Pyramid.
+
+Pagelets use :py:mod:`pyams_template` package, which participate in separation of Python view code
+and their template implementation, to split an HTML view template into two parts: a content
+template and a layout template. It also provides a "pagelet" ZCML directive which can be used to
+register pagelets, as well as a "pagelet_config" decorator which can be used alternatively.
+"""
 
 from pyramid.i18n import TranslationStringFactory
+
+
 _ = TranslationStringFactory('pyams_pagelet')