Added timeout to docs

Author: mikicz

arca/task.py

@@ -10,7 +10,8 @@
 
 class Task:
     """ A class for defining tasks the run in the repositories. The task is defined by an entry point,
-    arguments and keyword arguments. The class uses :class:`entrypoints.EntryPoint` to load the callables.
+    timeout (5 seconds by default), arguments and keyword arguments.
+    The class uses :class:`entrypoints.EntryPoint` to load the callables.
     As apposed to :class:`EntryPoint <entrypoints.EntryPoint>`, only objects are allowed, not modules.
 
     Let's presume we have this function in a package ``library.module``:
@@ -45,6 +46,9 @@ def __init__(self, entry_point: str, *,
 
         try:
             self._timeout = int(timeout)
+
+            if self._timeout < 1:
+                raise ValueError
         except ValueError:
             raise TaskMisconfigured("Provided timeout could not be converted to int.")
 

docs/tasks.rst

@@ -60,6 +60,15 @@ set up like this:
   task1 = Task("test:func", args=[5], kwargs={"y": 10})  # -> 50
   task2 = Task("test:func", kwargs={"x": 5, "y": 10})  # -> 50 again
 
+Timeout
+-------
+
+The :class:`arca.Task` class allows for a timeout to be defined with the task with the keyword argument ``timeout``.
+It must be a positive integer.
+The default value is 5 seconds.
+
+When a task exceeds a timeout, :class:`arca.exceptions.BuildTimeoutError` is raised.
+
 Result
 ------