Add tip about referencing env vars for args in powershell (#173) c46c9c2

nat-n · Oct 17, 2023 · 622c49f · 622c49f
1 parent 059285c
commit 622c49f
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 1 deletion.
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/guides/args_guide.doctree b/.doctrees/guides/args_guide.doctree
diff --git a/_sources/guides/args_guide.rst.txt b/_sources/guides/args_guide.rst.txt
@@ -195,6 +195,9 @@ The resulting task can be run like:
 
   poe passby --planet mars
 
+.. TIP::
+   For PowerShell tasks, the variable needs to be referenced as an environment variable in the shell code, e.g., :code:`$env:planet`.
+
 Arguments for script tasks
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/guides/args_guide.html b/guides/args_guide.html
@@ -426,6 +426,10 @@ <h2>Arguments for cmd and shell tasks<a class="headerlink" href="#arguments-for-
 <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>poe<span class="w"> </span>passby<span class="w"> </span>--planet<span class="w"> </span>mars
 </pre></div>
 </div>
+<div class="admonition tip">
+<p class="admonition-title">Tip</p>
+<p>For PowerShell tasks, the variable needs to be referenced as an environment variable in the shell code, e.g., <code class="code docutils literal notranslate"><span class="pre">$env:planet</span></code>.</p>
+</div>
 </section>
 <section id="arguments-for-script-tasks">
 <h2>Arguments for script tasks<a class="headerlink" href="#arguments-for-script-tasks" title="Permalink to this heading">#</a></h2>

diff --git a/searchindex.js b/searchindex.js