From 8a0ac52500e1464cd79634cbbda2de37d28847c2 Mon Sep 17 00:00:00 2001
From: Alexander Schlemmer <alexander@mail-schlemmer.de>
Date: Mon, 28 Jun 2021 12:26:22 +0200
Subject: [PATCH] DOC added documentation for a function in yaml API

---
 src/caosdb/yamlapi.py | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/caosdb/yamlapi.py b/src/caosdb/yamlapi.py
index b2e52798..ae8c760d 100644
--- a/src/caosdb/yamlapi.py
+++ b/src/caosdb/yamlapi.py
@@ -73,6 +73,11 @@ def dict_to_xml(d):
 
 
 def yaml_to_xml(yamlstr):
+    """
+    yamlstr: The string to load the yaml document from.
+    Loads a yaml document from yamlstr and converts
+    it to XML.
+    """
     return dict_to_xml(yaml.load(yamlstr))
 
 
-- 
GitLab