doc update
authorSylvain Thénault <sylvain.thenault@logilab.fr>
Thu, 13 Aug 2009 12:23:06 +0200
changeset 2825 87ac03aed941
parent 2824 3455f72010fe
child 2826 a4ddd807c5ee
doc update
appobject.py
req.py
--- a/appobject.py	Thu Aug 13 12:18:55 2009 +0200
+++ b/appobject.py	Thu Aug 13 12:23:06 2009 +0200
@@ -213,24 +213,23 @@
     Moreover, the `__abstract__` attribute may be set to True to indicate
     that a appobject is abstract and should not be registered.
 
-    At registration time, the following attributes are set on the class:
-    :vreg:
-      the instance's registry
-    :schema:
-      the instance's schema
-    :config:
-      the instance's configuration
+    At selection time, the following attributes are set on the instance:
+
+    :cw_req:
+      current request
+    :cw_extra_kwargs:
+      other received arguments
 
-    At selection time, the following attributes are set on the instance:
-    :req:
-      current request
-    :rset:
+    only if rset is found in arguments (in which case rset/row/col will be
+    removed from cwextra_kwargs):
+
+    :cw_rset:
       context result set or None
-    :row:
+    :cw_row:
       if a result set is set and the context is about a particular cell in the
       result set, and not the result set as a whole, specify the row number we
       are interested in, else None
-    :col:
+    :cw_col:
       if a result set is set and the context is about a particular cell in the
       result set, and not the result set as a whole, specify the col number we
       are interested in, else None
--- a/req.py	Thu Aug 13 12:18:55 2009 +0200
+++ b/req.py	Thu Aug 13 12:23:06 2009 +0200
@@ -30,6 +30,15 @@
 
 class RequestSessionBase(object):
     """base class containing stuff shared by server session and web request
+
+    request/session is the main resources accessor, mainly through it's vreg
+    attribute:
+    :vreg:
+      the instance's registry
+    :vreg.schema:
+      the instance's schema
+    :vreg.config:
+      the instance's configuration
     """
     def __init__(self, vreg):
         self.vreg = vreg