#66: Improve docs

riotkit-org · Aug 28, 2021 · ab09929 · ab09929
1 parent a2a17a4
commit ab09929
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 3 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -99,7 +99,7 @@ Keep learning
    extending-tasks
    pipelines
    project-structure
-   usage/index
    standardlib/index
+   usage/index
    rts/index
 
diff --git a/docs/source/standardlib/shell.rst b/docs/source/standardlib/shell.rst
@@ -9,7 +9,7 @@ Provides tasks for shell commands execution - mostly used in YAML syntax and in
 .. jinja:: shell
    :file: source/templates/package-usage.rst
 
-Executes a Bash script. Can be multi-line.
+Executes a Bash script. Can be multi-line. Script can read from stdin instead of :code:`-c` switch, if configured with :code:`is_cmd_required = True` during configuration stage.
 
 .. HINT::
     Phrase %RKD% is replaced with an rkd binary name
@@ -22,7 +22,6 @@ Executes a Bash script. Can be multi-line.
 .. code:: bash
 
     rkd :sh -c "ps aux"
-    rkd :sh --background -c "some-heavy-task"
 
 
 **Example of task alias usage:**