src/pyams_utils/adapter.py
changeset 72 9049384a2bd4
parent 13 e84adc865c35
child 117 c43465fd39a8
--- a/src/pyams_utils/adapter.py	Tue Nov 15 10:43:55 2016 +0100
+++ b/src/pyams_utils/adapter.py	Fri Nov 18 15:28:54 2016 +0100
@@ -10,6 +10,14 @@
 # FOR A PARTICULAR PURPOSE.
 #
 
+__doc__ = """Adapters management package
+
+This package provides a small set of standard base adapters for *context*, *context* and *request*, and
+*context* and *request* and *view*.
+
+See :ref:`zca` to see how PyAMS can help components management.
+"""
+
 __docformat__ = 'restructuredtext'
 
 
@@ -33,7 +41,7 @@
 
 
 class ContextRequestAdapter(object):
-    """Context + request adapter"""
+    """Context + request multi-adapter"""
 
     def __init__(self, context, request):
         self.context = context
@@ -41,7 +49,7 @@
 
 
 class ContextRequestViewAdapter(object):
-    """Context + request + view adapter"""
+    """Context + request + view multi-adapter"""
 
     def __init__(self, context, request, view):
         self.context = context
@@ -50,7 +58,14 @@
 
 
 class adapter_config(object):
-    """Function or class decorator to declare an adapter"""
+    """Function or class decorator to declare an adapter
+
+    Annotation parameters can be:
+
+    :param str name: (default=''), name of the adapter
+    :param [Interface...] context: an interface, or a tuple of interfaces, that the component adapts
+    :param Interface provides: the interface that the adapter provides
+    """
 
     venusian = venusian