Merge branch 'development' b4026e7

nat-n · Feb 25, 2024 · f0a557d · f0a557d
1 parent a74cacd
commit f0a557d
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 2 deletions.
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/tasks/task_types/ref.doctree b/.doctrees/tasks/task_types/ref.doctree
diff --git a/_sources/tasks/task_types/ref.rst.txt b/_sources/tasks/task_types/ref.rst.txt
@@ -33,3 +33,9 @@ Available task options
 ----------------------
 
 ``ref`` tasks support all of the :doc:`standard task options <../options>` with the exception of ``use_exec``.
+
+
+Passing arguments
+-----------------
+
+By default any arguments passed to a ref task will be forwarded to the referenced task, allowing it to function as a task alias. If named arguments are configured for the ref task then additional arguments can still be passed to the referenced task after ``--`` on the command line.
diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.24.4',
+    VERSION: '0.25.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/objects.inv b/objects.inv
diff --git a/searchindex.js b/searchindex.js
diff --git a/tasks/task_types/ref.html b/tasks/task_types/ref.html
@@ -258,6 +258,10 @@ <h1><code class="docutils literal notranslate"><span class="pre">ref</span></cod
 <h2>Available task options<a class="headerlink" href="#available-task-options" title="Permalink to this heading">#</a></h2>
 <p><code class="docutils literal notranslate"><span class="pre">ref</span></code> tasks support all of the <a class="reference internal" href="../options.html"><span class="doc">standard task options</span></a> with the exception of <code class="docutils literal notranslate"><span class="pre">use_exec</span></code>.</p>
 </section>
+<section id="passing-arguments">
+<h2>Passing arguments<a class="headerlink" href="#passing-arguments" title="Permalink to this heading">#</a></h2>
+<p>By default any arguments passed to a ref task will be forwarded to the referenced task, allowing it to function as a task alias. If named arguments are configured for the ref task then additional arguments can still be passed to the referenced task after <code class="docutils literal notranslate"><span class="pre">--</span></code> on the command line.</p>
+</section>
 </section>
 
         </article>
@@ -329,6 +333,7 @@ <h2>Available task options<a class="headerlink" href="#available-task-options" t
             <ul>
 <li><a class="reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">ref</span></code> tasks</a><ul>
 <li><a class="reference internal" href="#available-task-options">Available task options</a></li>
+<li><a class="reference internal" href="#passing-arguments">Passing arguments</a></li>
 </ul>
 </li>
 </ul>