Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
jnoortheen committed Dec 8, 2024
1 parent a4e6594 commit 2fd34ea
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion dev/_modules/xonsh/completers/commands.html
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,7 @@ <h1>Source code for xonsh.completers.commands</h1><div class="highlight"><pre>
<span class="n">kwargs</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">if</span> <span class="n">show_desc</span><span class="p">:</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;description&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;Alias&quot;</span> <span class="k">if</span> <span class="n">is_alias</span> <span class="k">else</span> <span class="n">path</span>
<span class="k">yield</span> <span class="n">RichCompletion</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">append_space</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">yield</span> <span class="n">RichCompletion</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">append_space</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="c1"># type: ignore</span>
<span class="k">if</span> <span class="n">xp</span><span class="o">.</span><span class="n">ON_WINDOWS</span><span class="p">:</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">executables_in</span><span class="p">(</span><span class="s2">&quot;.&quot;</span><span class="p">):</span>
<span class="k">if</span> <span class="n">i</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
Expand Down
2 changes: 1 addition & 1 deletion dev/api/_autosummary/cmd/xonsh.completers.completer.html
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,7 @@

<dl class="py function">
<dt class="sig sig-object py" id="xonsh.completers.completer.remove_completer">
<span class="sig-prename descclassname"><span class="pre">xonsh.completers.completer.</span></span><span class="sig-name descname"><span class="pre">remove_completer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">name:</span> <span class="pre">~typing.Annotated[str,</span> <span class="pre">((),</span> <span class="pre">(('completer',</span> <span class="pre">&lt;function</span> <span class="pre">complete_completer_names</span> <span class="pre">at</span> <span class="pre">0x7f1b19a7f5b0&gt;),))]</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/xonsh/completers/completer.html#remove_completer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#xonsh.completers.completer.remove_completer" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">xonsh.completers.completer.</span></span><span class="sig-name descname"><span class="pre">remove_completer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">name:</span> <span class="pre">~typing.Annotated[str,</span> <span class="pre">((),</span> <span class="pre">(('completer',</span> <span class="pre">&lt;function</span> <span class="pre">complete_completer_names</span> <span class="pre">at</span> <span class="pre">0x7fa8e4a5b5b0&gt;),))]</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/xonsh/completers/completer.html#remove_completer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#xonsh.completers.completer.remove_completer" title="Link to this definition"></a></dt>
<dd><p>Removes a completer from xonsh</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down
2 changes: 1 addition & 1 deletion dev/api/_autosummary/cmd/xonsh.procs.jobs.html
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@

<dl class="py function">
<dt class="sig sig-object py" id="xonsh.procs.jobs.disown_fn">
<span class="sig-prename descclassname"><span class="pre">xonsh.procs.jobs.</span></span><span class="sig-name descname"><span class="pre">disown_fn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">job_ids:</span> <span class="pre">~typing.Annotated[~typing.Sequence[int],</span> <span class="pre">((),</span> <span class="pre">(('type',</span> <span class="pre">&lt;class</span> <span class="pre">'int'&gt;),</span> <span class="pre">('nargs',</span> <span class="pre">'*'),</span> <span class="pre">('completer',</span> <span class="pre">&lt;function</span> <span class="pre">job_id_completer</span> <span class="pre">at</span> <span class="pre">0x7f1b220c0700&gt;)))],</span> <span class="pre">force_auto_continue=False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/xonsh/procs/jobs.html#disown_fn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#xonsh.procs.jobs.disown_fn" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">xonsh.procs.jobs.</span></span><span class="sig-name descname"><span class="pre">disown_fn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">job_ids:</span> <span class="pre">~typing.Annotated[~typing.Sequence[int],</span> <span class="pre">((),</span> <span class="pre">(('type',</span> <span class="pre">&lt;class</span> <span class="pre">'int'&gt;),</span> <span class="pre">('nargs',</span> <span class="pre">'*'),</span> <span class="pre">('completer',</span> <span class="pre">&lt;function</span> <span class="pre">job_id_completer</span> <span class="pre">at</span> <span class="pre">0x7fa8e8fc4700&gt;)))],</span> <span class="pre">force_auto_continue=False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/xonsh/procs/jobs.html#disown_fn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#xonsh.procs.jobs.disown_fn" title="Link to this definition"></a></dt>
<dd><p>Remove the specified jobs from the job table; the shell will no longer
report their status, and will not complain if you try to exit an
interactive shell with them running or stopped.</p>
Expand Down
2 changes: 1 addition & 1 deletion dev/api/_autosummary/helpers/xonsh.tracer.html
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,7 @@

<dl class="py method">
<dt class="sig sig-object py" id="xonsh.tracer.TracerType.toggle_color">
<span class="sig-name descname"><span class="pre">toggle_color</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">toggle:</span> <span class="pre">~typing.Annotated[bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">(()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">(('type'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">&lt;function</span> <span class="pre">to_bool</span> <span class="pre">at</span> <span class="pre">0x7f1b2235aa70&gt;)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">('completer'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">None)))]</span> <span class="pre">=</span> <span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/xonsh/tracer.html#TracerType.toggle_color"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#xonsh.tracer.TracerType.toggle_color" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">toggle_color</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">toggle:</span> <span class="pre">~typing.Annotated[bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">(()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">(('type'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">&lt;function</span> <span class="pre">to_bool</span> <span class="pre">at</span> <span class="pre">0x7fa8e925ea70&gt;)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">('completer'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">None)))]</span> <span class="pre">=</span> <span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/xonsh/tracer.html#TracerType.toggle_color"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#xonsh.tracer.TracerType.toggle_color" title="Link to this definition"></a></dt>
<dd><p>output color management for tracer</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down
6 changes: 3 additions & 3 deletions dev/api/_autosummary/helpers/xonsh.xontribs.html
Original file line number Diff line number Diff line change
Expand Up @@ -770,7 +770,7 @@

<dl class="py function">
<dt class="sig sig-object py" id="xonsh.xontribs.xontribs_load">
<span class="sig-prename descclassname"><span class="pre">xonsh.xontribs.</span></span><span class="sig-name descname"><span class="pre">xontribs_load</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">names:</span> <span class="pre">~typing.Annotated[~typing.Sequence[str],</span> <span class="pre">((),</span> <span class="pre">(('nargs',</span> <span class="pre">'+'),</span> <span class="pre">('completer',</span> <span class="pre">&lt;function</span> <span class="pre">xontrib_names_completer</span> <span class="pre">at</span> <span class="pre">0x7f1b22162c20&gt;)))]</span> <span class="pre">=</span> <span class="pre">(),</span> <span class="pre">verbose=False,</span> <span class="pre">full_module=False,</span> <span class="pre">suppress_warnings=False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/xonsh/xontribs.html#xontribs_load"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#xonsh.xontribs.xontribs_load" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">xonsh.xontribs.</span></span><span class="sig-name descname"><span class="pre">xontribs_load</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">names:</span> <span class="pre">~typing.Annotated[~typing.Sequence[str],</span> <span class="pre">((),</span> <span class="pre">(('nargs',</span> <span class="pre">'+'),</span> <span class="pre">('completer',</span> <span class="pre">&lt;function</span> <span class="pre">xontrib_names_completer</span> <span class="pre">at</span> <span class="pre">0x7fa8e9066c20&gt;)))]</span> <span class="pre">=</span> <span class="pre">(),</span> <span class="pre">verbose=False,</span> <span class="pre">full_module=False,</span> <span class="pre">suppress_warnings=False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/xonsh/xontribs.html#xontribs_load"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#xonsh.xontribs.xontribs_load" title="Link to this definition"></a></dt>
<dd><p>Load xontribs from a list of names</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand All @@ -796,7 +796,7 @@

<dl class="py function">
<dt class="sig sig-object py" id="xonsh.xontribs.xontribs_reload">
<span class="sig-prename descclassname"><span class="pre">xonsh.xontribs.</span></span><span class="sig-name descname"><span class="pre">xontribs_reload</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">names:</span> <span class="pre">~typing.Annotated[~typing.Sequence[str],</span> <span class="pre">((),</span> <span class="pre">(('nargs',</span> <span class="pre">'+'),</span> <span class="pre">('completer',</span> <span class="pre">&lt;function</span> <span class="pre">xontrib_unload_completer</span> <span class="pre">at</span> <span class="pre">0x7f1b22162cb0&gt;)))]</span> <span class="pre">=</span> <span class="pre">(),</span> <span class="pre">verbose=False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/xonsh/xontribs.html#xontribs_reload"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#xonsh.xontribs.xontribs_reload" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">xonsh.xontribs.</span></span><span class="sig-name descname"><span class="pre">xontribs_reload</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">names:</span> <span class="pre">~typing.Annotated[~typing.Sequence[str],</span> <span class="pre">((),</span> <span class="pre">(('nargs',</span> <span class="pre">'+'),</span> <span class="pre">('completer',</span> <span class="pre">&lt;function</span> <span class="pre">xontrib_unload_completer</span> <span class="pre">at</span> <span class="pre">0x7fa8e9066cb0&gt;)))]</span> <span class="pre">=</span> <span class="pre">(),</span> <span class="pre">verbose=False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/xonsh/xontribs.html#xontribs_reload"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#xonsh.xontribs.xontribs_reload" title="Link to this definition"></a></dt>
<dd><p>Reload the given xontribs</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand All @@ -810,7 +810,7 @@

<dl class="py function">
<dt class="sig sig-object py" id="xonsh.xontribs.xontribs_unload">
<span class="sig-prename descclassname"><span class="pre">xonsh.xontribs.</span></span><span class="sig-name descname"><span class="pre">xontribs_unload</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">names:</span> <span class="pre">~typing.Annotated[~typing.Sequence[str],</span> <span class="pre">((),</span> <span class="pre">(('nargs',</span> <span class="pre">'+'),</span> <span class="pre">('completer',</span> <span class="pre">&lt;function</span> <span class="pre">xontrib_unload_completer</span> <span class="pre">at</span> <span class="pre">0x7f1b22162cb0&gt;)))]</span> <span class="pre">=</span> <span class="pre">(),</span> <span class="pre">verbose=False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/xonsh/xontribs.html#xontribs_unload"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#xonsh.xontribs.xontribs_unload" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">xonsh.xontribs.</span></span><span class="sig-name descname"><span class="pre">xontribs_unload</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">names:</span> <span class="pre">~typing.Annotated[~typing.Sequence[str],</span> <span class="pre">((),</span> <span class="pre">(('nargs',</span> <span class="pre">'+'),</span> <span class="pre">('completer',</span> <span class="pre">&lt;function</span> <span class="pre">xontrib_unload_completer</span> <span class="pre">at</span> <span class="pre">0x7fa8e9066cb0&gt;)))]</span> <span class="pre">=</span> <span class="pre">(),</span> <span class="pre">verbose=False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/xonsh/xontribs.html#xontribs_unload"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#xonsh.xontribs.xontribs_unload" title="Link to this definition"></a></dt>
<dd><p>Unload the given xontribs</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down
4 changes: 2 additions & 2 deletions dev/envvars.html
Original file line number Diff line number Diff line change
Expand Up @@ -775,15 +775,15 @@ <h1>Environment Variables<a class="headerlink" href="#environment-variables" tit
<span id="id2"></span><h3>$HOSTNAME<a class="headerlink" href="#hostname" title="Link to this heading"></a></h3>
<p>Automatically set to the name of the current host.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> &lt;function GeneralSetting.&lt;lambda&gt; at 0x7f1b22295ea0&gt;</p>
<p><strong>default:</strong> &lt;function GeneralSetting.&lt;lambda&gt; at 0x7fa8e9199ea0&gt;</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
<section id="hosttype">
<span id="id3"></span><h3>$HOSTTYPE<a class="headerlink" href="#hosttype" title="Link to this heading"></a></h3>
<p>Automatically set to a string that fully describes the system type on which xonsh is executing.</p>
<p><strong>configurable:</strong> True</p>
<p><strong>default:</strong> &lt;function GeneralSetting.&lt;lambda&gt; at 0x7f1b22295f30&gt;</p>
<p><strong>default:</strong> &lt;function GeneralSetting.&lt;lambda&gt; at 0x7fa8e9199f30&gt;</p>
<p><strong>store_as_str:</strong> False</p>
<hr class="docutils" />
</section>
Expand Down
2 changes: 1 addition & 1 deletion dev/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 2fd34ea

Please sign in to comment.