[form fields doc] explain when field.role should be None stable
authorSylvain Thénault <sylvain.thenault@logilab.fr>
Mon, 05 Sep 2011 16:48:37 +0200
branchstable
changeset 7756 98e34ae4cf89
parent 7755 bb2a92909d46
child 7757 5b3584c5a7c3
[form fields doc] explain when field.role should be None
web/formfields.py
--- a/web/formfields.py	Fri Aug 26 17:28:32 2011 +0200
+++ b/web/formfields.py	Mon Sep 05 16:48:37 2011 +0200
@@ -148,7 +148,9 @@
        bool flag telling if this field is linked to a specific entity
     :attr:`role`
        when the field is linked to an entity attribute or relation, tells the
-       role of the entity in the relation (eg 'subject' or 'object')
+       role of the entity in the relation (eg 'subject' or 'object'). If this is
+       not an attribute or relation of the edited entity, `role` should be
+       `None`.
     :attr:`fieldset`
        optional fieldset to which this field belongs to
     :attr:`order`