From 4f5269613ff3046956dbb998c405eda0dc9624cb Mon Sep 17 00:00:00 2001
From: David Straub <david.straub@tum.de>
Date: Tue, 21 Mar 2017 08:48:45 +0100
Subject: [PATCH] [classes] Doc string for get_yaml

---
 flavio/classes.py | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/flavio/classes.py b/flavio/classes.py
index 6fdb7f40..bd7dcb1a 100644
--- 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'):