Merge commit d30f2cb6 from release-2020 into master

[alexxy/gromacs.git] / python_packaging / src / gmxapi / operation.py

diff --git a/python_packaging/src/gmxapi/operation.py b/python_packaging/src/gmxapi/operation.py
index 9468136e2060a2f265774068ab04116070ed2464..5e36d9ff1aced4025a31bf964bf963e9519271b4 100644 (file)
--- a/python_packaging/src/gmxapi/operation.py
+++ b/python_packaging/src/gmxapi/operation.py
@@ -1,7 +1,7 @@
 #
 # This file is part of the GROMACS molecular simulation package.
 #
-# Copyright (c) 2019, by the GROMACS development team, led by
+# Copyright (c) 2019,2020, by the GROMACS development team, led by
 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
 # and including many others, as listed in the AUTHORS file in the
 # top-level source directory and at http://www.gromacs.org.
@@ -2618,7 +2618,7 @@ def function_wrapper(output: dict = None):
     New function accepts the same arguments, with additional arguments required by
     the API.
 
-    The new function returns an object with an `output` attribute containing the named outputs.
+    The new function returns an object with an ``output`` attribute containing the named outputs.
 
     Example:
 
@@ -2631,9 +2631,12 @@ def function_wrapper(output: dict = None):
         >>> assert operation1.output.spam.result() == 'spam spam'
         >>> assert operation1.output.foo.result() == 'spam spam spam spam'
 
-    If 'output' is provided to the wrapper, a data structure will be passed to
+    Arguments:
+        output (dict): output names and types
+
+    If ``output`` is provided to the wrapper, a data structure will be passed to
     the wrapped functions with the named attributes so that the function can easily
-    publish multiple named results. Otherwise, the `output` of the generated operation
+    publish multiple named results. Otherwise, the ``output`` of the generated operation
     will just capture the return value of the wrapped function.
 
     .. todo:: gmxapi typing stub file(s).