[classes] Doc string for get_yaml

flav-io · Mar 21, 2017 · 4f52696 · 4f52696
1 parent 74fef8f
commit 4f52696
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/flavio/classes.py b/flavio/classes.py
@@ -288,6 +288,12 @@ def copy(self):
         return copy.deepcopy(self)
 
     def get_yaml(self, *args, **kwargs):
+        """Get a YAML string representation of all constraints.
+
+        The optional parameter `pname` allows to customize the name of the key
+        containing the parameter list of each constraint (e.g. 'parameters',
+        'observables').
+        """
         return yaml.dump(self.get_yaml_dict(*args, **kwargs))
 
     def get_yaml_dict(self, pname='parameters'):