From: Thierry Parmentelat <thierry.parmentelat@inria.fr>
Date: Wed, 3 Jun 2015 15:12:37 +0000 (+0200)
Subject: add a docstring note about Allocate and the append option
X-Git-Tag: sfa-3.1-16~3
X-Git-Url: http://git.onelab.eu/?a=commitdiff_plain;h=be71b8d7c957590aecb593e5c9be315aa189729f;hp=63bb6c04ee9f566071c3211a76e22559595d42e6;p=sfa.git

add a docstring note about Allocate and the append option
---

diff --git a/sfa/methods/Allocate.py b/sfa/methods/Allocate.py
index e386b308..e1367667 100644
--- a/sfa/methods/Allocate.py
+++ b/sfa/methods/Allocate.py
@@ -23,7 +23,16 @@ class Allocate(Method):
     @param slice_urn (string) URN of slice to allocate to
     @param credentials (dict) of credentials
     @param rspec (string) rspec to allocate
-    
+    @param options (dict)
+
+    The PL driver implements here an important option named
+    'append' that affects the management of slice tags. 
+    It is recommended to set this option to True, and to not pass
+    any slice tag in the incoming rspec, in which case
+    you are guaranteed to leave slice tags alone.
+
+    See also http://svn.planet-lab.org/wiki/SFASliceTags
+
     """
     interfaces = ['aggregate', 'slicemgr']
     accepts = [