From: Thierry Parmentelat <thierry.parmentelat@sophia.inria.fr>
Date: Tue, 23 Nov 2010 21:24:23 +0000 (+0100)
Subject: comment on define_accessors
X-Git-Tag: plcapi-5.0-19~37
X-Git-Url: http://git.onelab.eu/?a=commitdiff_plain;h=2c5ee3c719cc2b6728b0a7ba75cf61e9cd51777a;p=plcapi.git

comment on define_accessors
---

diff --git a/PLC/Accessors/Factory.py b/PLC/Accessors/Factory.py
index c6e87f36..01d8c816 100644
--- a/PLC/Accessors/Factory.py
+++ b/PLC/Accessors/Factory.py
@@ -70,6 +70,9 @@ tech_roles = [ 'admin', 'pi', 'tech' ]
 # named min_role_id; this was redundant and confusing, it has been
 # removed, we now use set_roles to restrict access on the corresponding tag
 
+# the convention here is that methodsuffix should be mixed case, e.g. MyStuff
+# while tagname is expected to be lowercase
+# you then end up with e.g. GetPersonMyStuff
 def define_accessors (module, objclass, methodsuffix, tagname,
                       category, description,
                       get_roles=all_roles, set_roles=admin_roles,