aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar ionite34 <[email protected]>2022-11-22 14:11:03 -0500
committerGravatar ionite34 <[email protected]>2022-11-22 14:11:03 -0500
commit08f5dfa98d184c9c613624c3efbef08e7974610e (patch)
tree6f95740d642db7775d17013bba2eed80c9be116a
parentFixed leading empty filter for py_args (diff)
Update docstrings
-rw-r--r--snekbox/utils/timed.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/snekbox/utils/timed.py b/snekbox/utils/timed.py
index 4acfa0d..02388ff 100644
--- a/snekbox/utils/timed.py
+++ b/snekbox/utils/timed.py
@@ -18,6 +18,12 @@ def timed(
"""
Call a function with a time limit.
+ Args:
+ func: Function to call.
+ args: Arguments for function.
+ kwds: Keyword arguments for function.
+ timeout: Timeout limit in seconds.
+
Raises:
TimeoutError: If the function call takes longer than `timeout` seconds.
"""