From 241bbfea46ebe29f46d77d9abf60a3e779818a88 Mon Sep 17 00:00:00 2001 From: gofrendi Date: Sun, 14 Jan 2024 07:18:35 +0700 Subject: [PATCH] improve writing --- docs/concepts/runner-group-and-task.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/concepts/runner-group-and-task.md b/docs/concepts/runner-group-and-task.md index fadb5bc2..2cd4e251 100644 --- a/docs/concepts/runner-group-and-task.md +++ b/docs/concepts/runner-group-and-task.md @@ -32,7 +32,7 @@ task = Task(name='task') runner.register(task) ``` -To access the task, you need to run the following command in your terminal: +To access the registered Task, you need to run the following command in your terminal: ```bash zrb task @@ -50,7 +50,7 @@ task = Task(name='task', group=group) runner.register(task) ``` -To access the Grouped Task, you can run the following command in your terminal: +To access the registered Grouped Task, you can run the following command in your terminal: ```bash zrb group task @@ -58,14 +58,14 @@ zrb group task ## Limitations And Restrictions -- You can only register a task once. -- Registered tasks cannot have the same names under the same group names. +- You can only register a Task once. +- Registered Tasks cannot have the same names under the same Group names. Let's see some examples: ### Invalid Examples -The following example is invalid because you cannot register a task twice: +The following example is invalid because you can only register a Task once: ```python from zrb import runner, Task @@ -87,7 +87,7 @@ task_2 = Task(name='task') runner.register(task_2) # This yield error. ``` -The following is also invalid because the Tasks shared the same name and were under the same group name. +The following is also invalid because the Tasks shared the same name and were under the same Group name. ```python from zrb import runner, Group, Task @@ -103,6 +103,8 @@ runner.register(task_2) # This yield error. ### Valid Examples +The following example is valid. Even though `task_1` and `task_2` shared the same name, they were defined under different Groups. + ```python from zrb import runner, Task, Group @@ -124,7 +126,6 @@ runner.register(task_2) # OK, task_1 and task_2 are located under different grou

- You can use Group to organize your Tasks. A Group will only be accessible from the CLI if at least one registered Task is under it. You can also put a Group under another Group. Hierarchically speaking, you can think of Task Groups as directories to organize your Tasks.