[entity doc] fix typo (rest_var instead of rest_attr) and cleanup doc
authorSylvain Thénault <sylvain.thenault@logilab.fr>
Wed, 21 Sep 2011 17:38:44 +0200
changeset 7816 a8a424a78c26
parent 7812 6806a7db9732
child 7821 3ecd114f6d75
[entity doc] fix typo (rest_var instead of rest_attr) and cleanup doc
entity.py
--- a/entity.py	Tue Sep 20 09:20:41 2011 +0200
+++ b/entity.py	Wed Sep 21 17:38:44 2011 +0200
@@ -77,17 +77,16 @@
     :type e_schema: `cubicweb.schema.EntitySchema`
     :ivar e_schema: the entity's schema
 
-    :type rest_var: str
-    :cvar rest_var: indicates which attribute should be used to build REST urls
-                    If None is specified, the first non-meta attribute will
-                    be used
+    :type rest_attr: str
+    :cvar rest_attr: indicates which attribute should be used to build REST urls
+       If `None` is specified (the default), the first unique attribute will
+       be used ('eid' if none found)
 
     :type cw_skip_copy_for: list
     :cvar cw_skip_copy_for: a list of couples (rtype, role) for each relation
-                            that should be skipped when copying
-                            this kind of entity. Note that some relations such
-                            as composite relations or relations that have '?1' as object
-                            cardinality are always skipped.
+       that should be skipped when copying this kind of entity. Note that some
+       relations such as composite relations or relations that have '?1' as
+       object cardinality are always skipped.
     """
     __registry__ = 'etypes'
     __select__ = yes()