Update API reference

tum-esm · Nov 13, 2023 · 64bb633 · 64bb633
1 parent 5315c68
commit 64bb633
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/docs/pages/api-reference.md b/docs/pages/api-reference.md
@@ -405,12 +405,16 @@ will be used as the working directory for the process.
 ##### `terminate_process`
 
 ```python
-def terminate_process(script_path: str) -> list[int]
+def terminate_process(script_path: str,
+                      termination_timeout: Optional[int] = None) -> list[int]
 ```
 
 Terminate all processes that have the given script as their
 entrypoint. Returns the list of terminated PIDs.
 
+If `termination_timeout` is not None, the processes will be
+terminated forcefully after the given timeout (in seconds).
+
 
 ## `tum_esm_utils.shell`
 

diff --git a/scripts/generate_docs.py b/scripts/generate_docs.py
@@ -1,3 +1,4 @@
+from __future__ import annotations
 import os
 import tempfile