From: Marc Fiuczynski <mef@cs.princeton.edu>
Date: Tue, 26 May 2009 15:13:35 +0000 (+0000)
Subject: Needed to add documentation for the class definition
X-Git-Tag: PLCAPI-4.3-16~7
X-Git-Url: http://git.onelab.eu/?a=commitdiff_plain;h=bb1ef12d93f390e157dc06686f75ea507e2c2856;p=plcapi.git

Needed to add documentation for the class definition
---

diff --git a/PLC/Methods/GetNodes.py b/PLC/Methods/GetNodes.py
index f817841..89812ac 100644
--- a/PLC/Methods/GetNodes.py
+++ b/PLC/Methods/GetNodes.py
@@ -87,7 +87,6 @@ node_fields = Node.fields.copy()
 node_fields['nodenetwork_ids']=Parameter([int], "Legacy version of interface_ids")
 
 class v42GetNodes(v43GetNodes):
-    # XXX is there a way to inherit the doc from v43GetNodes?
     """
     Returns an array of structs containing details about nodes. If
     node_filter is specified and is an array of node identifiers or
diff --git a/PLC/Methods/GetSlices.py b/PLC/Methods/GetSlices.py
index 2209526..f41dde3 100644
--- a/PLC/Methods/GetSlices.py
+++ b/PLC/Methods/GetSlices.py
@@ -76,6 +76,18 @@ class v43GetSlices(Method):
         return slices
 
 class v42GetSlices(v43GetSlices):
+    """
+    Returns an array of structs containing details about slices. If
+    slice_filter is specified and is an array of slice identifiers or
+    slice names, or a struct of slice attributes, only slices matching
+    the filter will be returned. If return_fields is specified, only the
+    specified details will be returned.
+
+    Users may only query slices of which they are members. PIs may
+    query any of the slices at their sites. Admins and nodes may query
+    any slice. If a slice that cannot be queried is specified in
+    slice_filter, details about that slice will not be returned.
+    """
 
     def call(self, auth, slice_filter = None, return_fields = None):
         # convert nodenetwork_ids -> interface_ids