From eaefb51b2b7f28bc79842c9a5beebf2a1aaa60e4 Mon Sep 17 00:00:00 2001
From: florian <f.spreckelsen@inidscale.com>
Date: Tue, 20 Jul 2021 10:16:36 +0200
Subject: [PATCH] DOC: format docstring
---
src/caosdb/yamlapi.py | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/src/caosdb/yamlapi.py b/src/caosdb/yamlapi.py
index ae8c760d..9a69a527 100644
--- a/src/caosdb/yamlapi.py
+++ b/src/caosdb/yamlapi.py
@@ -73,10 +73,13 @@ 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.
+ """Load a yaml document from yamlstr and converts it to XML.
+
+ Parameters
+ ----------
+ yamlstr : str
+ The string to load the yaml document from.
+
"""
return dict_to_xml(yaml.load(yamlstr))
--
GitLab