Merge pull request #36 from AutoResearch/docs/specify-docstring-fields

docs: specify empty docstring fields
AutoResearch · Jul 21, 2023 · 1a8910d · 1a8910d
2 parents 34afe19 + 73c2b5e
commit 1a8910d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/src/autora/experimentalist/pipeline.py b/src/autora/experimentalist/pipeline.py
@@ -191,7 +191,7 @@ def _merge_dicts(a: dict, b: dict):
         a: the "base" dictionary
         b: the "update" dictionary which takes precendence
 
-    Returns:
+    Returns: the combined dictionary
 
     Originally from https://stackoverflow.com/a/7205107, modified for AER to allow overwriting.
 

diff --git a/src/autora/state/delta.py b/src/autora/state/delta.py
@@ -206,9 +206,10 @@ def wrap_to_use_state(f):
     It was inspired by the pytest "fixtures" mechanism.
 
     Args:
-        f:
+        f: a function with arguments that could be fields on a `State`
+            and that returns a `Delta`.
 
-    Returns:
+    Returns: a version of `f` which takes and returns `State` objects.
 
     Examples:
         >>> from autora.state.delta import State, Delta