# HG changeset patch # User Nicolas Chauvat # Date 1278349710 -7200 # Node ID 4469f85ace9f8096b2515ca9b104f5b5f54e6e9f # Parent 214633a80961945e0d453200b92bdf97dd260e6c [doc] proof-reading and improvements diff -r 214633a80961 -r 4469f85ace9f doc/book/en/devrepo/entityclasses/adapters.rst --- a/doc/book/en/devrepo/entityclasses/adapters.rst Mon Jul 05 18:25:25 2010 +0200 +++ b/doc/book/en/devrepo/entityclasses/adapters.rst Mon Jul 05 19:08:30 2010 +0200 @@ -50,7 +50,7 @@ from cubicweb.entities.adapters import ITreeAdapter class MyEntityITreeAdapter(ITreeAdapter): - __select__ = implements('MyEntity') + __select__ = is_instance('MyEntity') tree_relation = 'filed_under' The ITreeAdapter here provides a default implementation. The @@ -124,6 +124,7 @@ class MyEntity(AnyEntity): __regid__ = 'MyEntity' + __implements__ = AnyEntity.__implements__ + (IFoo,) def bar(self, *args): return sum(captain.age for captain in self.captains) @@ -142,6 +143,7 @@ class IFooAdapter(EntityAdapter): __regid__ = 'IFoo' + __select__ = is_instance('MyEntity') def bar(self, *args): return sum(captain.age for captain in self.entity.captains) diff -r 214633a80961 -r 4469f85ace9f doc/book/en/devrepo/entityclasses/data-as-objects.rst --- a/doc/book/en/devrepo/entityclasses/data-as-objects.rst Mon Jul 05 18:25:25 2010 +0200 +++ b/doc/book/en/devrepo/entityclasses/data-as-objects.rst Mon Jul 05 19:08:30 2010 +0200 @@ -4,23 +4,22 @@ Python-level access to persistent data is provided by the :class:`Entity ` class. -An entity class is bound to a schema entity type. Descriptors are added when +.. XXX this part is not clear. refactor it. + +An entity class is bound to a schema entity type. Descriptors are added when classes are registered in order to initialize the class according to its schema: -* we can access the defined attributes in the schema thanks to the attributes of - the same name on instances (typed value) +* the attributes defined in the schema appear as attributes of these classes -* we can access the defined relations in the schema thanks to the relations of - the same name on instances (entities instances list) - +* the relations defined in the schema appear as attributes of these classes, + but are lists of instances `Formatting and output generation`: * `view(__vid, __registry='views', **kwargs)`, applies the given view to the entity (and returns an unicode string) -* `absolute_url(*args, **kwargs)`, returns an absolute URL to access the primary view - of an entity +* `absolute_url(*args, **kwargs)`, returns an absolute URL including the base-url * `rest_path()`, returns a relative REST URL to get the entity @@ -31,7 +30,7 @@ `Data handling`: * `as_rset()`, converts the entity into an equivalent result set simulating the - request `Any X WHERE X eid _eid_` + request `Any X WHERE X eid _eid_` * `complete(skip_bytes=True)`, executes a request that recovers at once all the missing attributes of an entity @@ -52,10 +51,10 @@ values given named parameters * `set_relations(**kwargs)`, add relations to the given object. To - set a relation where this entity is the object of the relation, - use `reverse_` as argument name. Values may be an - entity, a list of entities, or None (meaning that all relations of - the given type from or to this object should be deleted). + set a relation where this entity is the object of the relation, + use `reverse_` as argument name. Values may be an + entity, a list of entities, or None (meaning that all relations of + the given type from or to this object should be deleted). * `copy_relations(ceid)`, copies the relations of the entities having the eid given in the parameters on the current entity @@ -111,7 +110,7 @@ `Misc methods`: * `after_deletion_path`, return (path, parameters) which should be - used as redirect information when this entity is being deleted + used as redirect information when this entity is being deleted * `pre_web_edit`, callback called by the web editcontroller when an entity will be created/modified, to let a chance to do some entity