# HG changeset patch
# User Sylvain Thénault <sylvain.thenault@logilab.fr>
# Date 1315234117 -7200
# Node ID 98e34ae4cf89d8c1a4eb76de43523eb8be8f26e8
# Parent  bb2a92909d46da56898f7d321912855859a7d859
[form fields doc] explain when field.role should be None

diff -r bb2a92909d46 -r 98e34ae4cf89 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`