doc/book/en/development/vreg/appobject.rst
branchstable
changeset 5147 70181998897f
parent 5143 43afbdd5c8b4
--- a/doc/book/en/development/vreg/appobject.rst	Tue Apr 06 10:10:47 2010 +0200
+++ b/doc/book/en/development/vreg/appobject.rst	Tue Apr 06 10:11:40 2010 +0200
@@ -1,32 +1,7 @@
-
-
-The `AppObject` class
-~~~~~~~~~~~~~~~~~~~~~
-
-In general:
-
-* we do not inherit directly from this class but from a more specific
-  class such as `AnyEntity`, `EntityView`, `AnyRsetView`,
-  `Action`...
-
-* to be recordable, a subclass has to define its own register (attribute
-  `__registry__`) and its identifier (attribute `id`). Usually we do not have
-  to take care of the register, only the identifier `id`.
-
-We can find a certain number of attributes and methods defined in this class
-and common to all the application objects.
-
-At recording time, the following attributes are dynamically added to
-the *subclasses*:
-
-* `vreg`, the `vregistry` of the instance
-* `schema`, the instance schema
-* `config`, the instance configuration
-
-We also find on instances, the following attributes:
-
-* ._cw`, `Request` instance
-* `rset`, the *result set* associated to the object if necessary
+XXX todo:
+* configure members for doc generated for appojbect class,
+* configure module's member into the module
+* put doc below somewhere else
 
 :URL handling:
   * `build_url(*args, **kwargs)`, returns an absolute URL based on the
@@ -52,20 +27,3 @@
 
   * `tal_render(template, variables)`, renders a precompiled page template with
     variables in the given dictionary as context
-
-.. note::
-  When we inherit from `AppObject` (even not directly), you *always* have to use
-  **super()** to get the methods and attributes of the superclasses, and not
-  use the class identifier.
-
-  For example, instead of writting: ::
-
-      class Truc(PrimaryView):
-          def f(self, arg1):
-              PrimaryView.f(self, arg1)
-
-  You must write: ::
-
-      class Truc(PrimaryView):
-          def f(self, arg1):
-              super(Truc, self).f(arg1)