From e64283341d343a3207f8f55fadb3c1487b053033 Mon Sep 17 00:00:00 2001 From: Mikael Koli Date: Wed, 24 Nov 2021 01:02:11 +0200 Subject: [PATCH] docs: updated some docstrings and removed comment --- redengine/arguments/builtin.py | 38 +++++++++++++++++++++++++++++++++- redengine/conditions/meta.py | 4 ++++ redengine/core/schedule.py | 2 -- 3 files changed, 41 insertions(+), 3 deletions(-) diff --git a/redengine/arguments/builtin.py b/redengine/arguments/builtin.py index 367a534d..934f45ae 100644 --- a/redengine/arguments/builtin.py +++ b/redengine/arguments/builtin.py @@ -44,7 +44,26 @@ class Return(BaseArgument): Parameters ---------- name : str - Name of the task which return is represented. + Name of the task which return value the argument + represents. + + Examples + -------- + + .. code-block:: python + + from redengine.arguments import Return + from redengine.tasks import FuncTask + + # Create a task with a return + @FuncTask() + def my_task_1(): + ... + return data + + @FuncTask(parameters={"myarg": Return('my_task_1')}) + def my_task_2(myarg): + ... """ def __init__(self, task_name, default=None): @@ -80,6 +99,23 @@ class FuncArg(BaseArgument): Examples -------- + Simple example: + + .. code-block:: python + + from redengine.tasks import FuncTask + from redengine.arguments import FuncArg + + def my_func(): + ... + return obj + + @FuncTask(parameters={"my_param": FuncArg(my_func)}) + def my_task(my_param): + ... + + Example to set to session: + .. doctest:: funcarg >>> from redengine.arguments import FuncArg diff --git a/redengine/conditions/meta.py b/redengine/conditions/meta.py index 89b213a1..f220fb19 100644 --- a/redengine/conditions/meta.py +++ b/redengine/conditions/meta.py @@ -64,6 +64,10 @@ def is_foo(place): ... # Expensive check return True + Using the condition: + + .. code-block:: python + from redengine.tasks import FuncTask @FuncTask(start_cond="is foo at home") diff --git a/redengine/core/schedule.py b/redengine/core/schedule.py index 72759fc8..5c4a45d4 100644 --- a/redengine/core/schedule.py +++ b/redengine/core/schedule.py @@ -346,8 +346,6 @@ def handle_logs(self): del record.__return__ task.log_record(record) - # return_values = self._param_queue.get(block=False) - # self.returns[return_values[0]] = return_values[1] def handle_zombie_tasks(self): """If there are tasks that has been crashed during setting up the task loggers,