====

[plcapi.git] / PLC / Accessors / Accessors_site.py

diff --git a/PLC/Accessors/Accessors_site.py b/PLC/Accessors/Accessors_site.py
index cce0c51..b51d42e 100644 (file)
--- a/PLC/Accessors/Accessors_site.py
+++ b/PLC/Accessors/Accessors_site.py
@@ -24,7 +24,6 @@ from PLC.Interfaces import Interface
 from PLC.Slices import Slice
 from PLC.Sites import Site
 from PLC.Persons import Person
-#from PLC.Ilinks import Ilink
 
 from PLC.Accessors.Factory import define_accessors, all_roles, person_roles, tech_roles
 
@@ -32,9 +31,18 @@ import sys
 current_module = sys.modules[__name__]
 
 #### example : attach vlan ids on interfaces
-# The third argument expose_in_api is a boolean flag that tells whether this tag may be handled
-#   through the Add/Get/Update methods as a native field
 #
 #define_accessors(current_module, Interface, "Vlan", "vlan",
 #                  "interface/general", "tag for setting VLAN id",
 #                  get_roles=all_roles, set_roles=tech_roles)
+#
+# The optional expose_in_api is a boolean flag that tells whether this tag may be handled
+#   through the Add/Get/Update methods as a native field
+# e.g. 
+#define_accessors(current_module, Node, "Foo", "foo",
+#                  "node/example", "my own description for foo",
+#                  get_roles=all_roles, set_roles=all_roles)
+# will let you do
+# GetNodes ( {'foo':'*bar*'},['hostname','foo'])
+#
+#