[Checkins] SVN: grok/trunk/doc/reference/ - added description for 'subscriber' decorator

[Christian Theune]

Log message for revision 70870:
   - added description for 'subscriber' decorator
  

Changed:
  U   grok/trunk/doc/reference/decorators.tex
  U   grok/trunk/doc/reference/exceptions.tex

-=-
Modified: grok/trunk/doc/reference/decorators.tex
===================================================================
--- grok/trunk/doc/reference/decorators.tex	2006-10-21 15:49:15 UTC (rev 70869)
+++ grok/trunk/doc/reference/decorators.tex	2006-10-21 16:14:48 UTC (rev 70870)
@@ -6,11 +6,18 @@
     \section{\function{grok.subscribe} -- Register a function as a subscriber
     for an event}
 
-    Similar to Zope 3's \function{zope.component.subscriber} decorator, the
-    function where it is applied to is registered as a subscriber for an event. 
 
+        \begin{funcdesc}{subscribe}{*classes_or_interfaces}
 
+        Declare that the decorated function subscribes to an event or a
+        combination of objects and events. (Similar to Zope 3's
+        \function{subscriber} decorator.)
 
+        Applicable on module-level for functions. Requires at least one class
+        or interface as argument.
 
+        \end{funcdesc}
+
+
     \section{grok.action}
 

Modified: grok/trunk/doc/reference/exceptions.tex
===================================================================
--- grok/trunk/doc/reference/exceptions.tex	2006-10-21 15:49:15 UTC (rev 70869)
+++ grok/trunk/doc/reference/exceptions.tex	2006-10-21 16:14:48 UTC (rev 70870)
@@ -2,8 +2,8 @@
 
 grok tries to inform you about errors early and with as much guidance as
 possible. grok can detect some errors already while importing a module, which
-will lead to the \class{GrokImportError}.  Other errors require more context and can
-only be detected while executing the \function{grok} function.
+will lead to the \class{GrokImportError}.  Other errors require more context
+and can only be detected while executing the \function{grok} function.
 
     \section{\class{grok.GrokImportError} -- errors while importing a module}