js timeout: docs

Author: mr-c

cwl_utils/expression.py

@@ -289,6 +289,11 @@ def do_eval(
     cwlVersion: str = "",
     **kwargs: Any,
 ) -> Optional[CWLOutputType]:
+    """
+    Evaluate the given CWL expression, in context.
+
+    :param timeout: The maximum number of seconds to wait while executing.
+    """
     runtime = cast(MutableMapping[str, Union[int, str, None]], copy.deepcopy(resources))
     runtime["tmpdir"] = tmpdir if tmpdir else None
     runtime["outdir"] = outdir if outdir else None

cwl_utils/sandboxjs.py

@@ -34,6 +34,7 @@
 from cwl_utils.utils import singularity_supports_userns
 
 default_timeout = 20
+"""Default number of seconds to wait while running a javascript engine."""
 
 seg_symbol = r"""\w+"""
 seg_single = r"""\['([^']|\\')+'\]"""
@@ -164,6 +165,13 @@ def exec_js_process(
         force_docker_pull: bool = False,
         container_engine: str = "docker",
     ) -> Tuple[int, str, str]:
+        """
+        Run a javascript text.
+
+        :param timeout: Max number of seconds to wait.
+        :returns: A tuple of the return code, stdout, and stderr of the javascript
+                  engine invocation.
+        """
         if not hasattr(self.localdata, "procs"):
             self.localdata.procs = {}