mirrors/xonsh
1
0
Fork 0
mirror of https://github.com/xonsh/xonsh.git synced 2025-03-04 08:24:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Update tutorial.rst: fix decorator alias mention

Browse source
This commit is contained in:
Andy Kipp 2024-09-16 11:16:23 +02:00 • committed by GitHub
parent fabdfc0fdc
commit b437f19fc3
Failed to generate hash of commit
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/tutorial.rst
View file

@ -543,12 +543,12 @@ For example, the ``echo`` command has no interaction with the user and is captur
However, some tools have mixed behavior and can be run for either interactive or non-interactive tasks.
The best example of this is ``ssh``, which allows for remote terminal sessions and executing commands.
To handle different types of tasks, xonsh has the ``xthread`` and ``xunthread`` built-in aliases.
If you need to capture the output from an interactive tool that has a capturable mode use ``xthread`` to run:
To handle different types of tasks, xonsh has the ``@thread`` and ``@unthread`` built-in decorator aliases.
If you need to capture the output from an interactive tool that has a capturable mode use ``@thread`` to run:
.. code-block:: xonshcon
@ !(xthread ssh host -T 'echo remote')
@ !(@thread ssh host -T 'echo remote')
CommandPipeline(output="remote")