Document apispec.utils

marshmallow-code · Oct 3, 2015 · 5538ddc · 5538ddc
1 parent 8a17bf0
commit 5538ddc
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/apispec/utils.py b/apispec/utils.py
@@ -43,7 +43,7 @@ def dedent(content):
     return content.strip()
 
 def load_yaml_from_docstring(docstring):
-    """Loads YAML from docstring"""
+    """Loads YAML from docstring."""
     split_lines = trim_docstring(docstring).split('\n')
 
     # Cut YAML from rest of docstring
@@ -73,6 +73,9 @@ def load_yaml_from_docstring(docstring):
 ])
 
 def load_operations_from_docstring(docstring):
+    """Return a dictionary of Swagger operations parsed from a
+    a docstring.
+    """
     doc_data = load_yaml_from_docstring(docstring)
     if doc_data:
         return {key: val for key, val in iteritems(doc_data)

diff --git a/docs/api_core.rst b/docs/api_core.rst
@@ -12,3 +12,9 @@ apispec.exceptions
 
 .. automodule:: apispec.exceptions
     :members:
+
+apispec.utils
+-------------
+
+.. automodule:: apispec.utils
+    :members: