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

wrote tut

Browse source
This commit is contained in:
Anthony Scopatz 2016-10-30 10:47:32 -04:00
parent 86111a6ebf
commit 9f35a4ea69
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/tutorial.rst
View file

@ -1240,7 +1240,7 @@ as aliases, by wrapping them in ``@()``. For example:
Unthreadable Aliases Unthreadable Aliases
----------------------- -----------------------
Usually, callable alias commands will be run in a separate thread so that users Usually, callable alias commands will be run in a separate thread so that
they may be run in the background. However, some aliases may need to be they may be run in the background. However, some aliases may need to be
executed on the thread that they were called from. This is mostly useful for executed on the thread that they were called from. This is mostly useful for
debuggers and profilers. To make an alias run in the foreground, decorate its debuggers and profilers. To make an alias run in the foreground, decorate its
@ -1258,13 +1258,13 @@ function with the ``xonsh.proc.unthreadable`` decorator.
Uncapturable Aliases Uncapturable Aliases
----------------------- -----------------------
Also, callable alias by default will be executed such that their output is Also, callable aliases by default will be executed such that their output is
captured (like most commands in xonsh that don't enter alternate mode). captured (like most commands in xonsh that don't enter alternate mode).
However, some aliases may want to run alternate-mode commands themselves. However, some aliases may want to run alternate-mode commands themselves.
Thus the callabale alias can't be captured without dire consequences (tm). Thus the callable alias can't be captured without dire consequences (tm).
To prevent this, you can declare a callable alias uncapturable. This is mostly To prevent this, you can declare a callable alias uncapturable. This is mostly
useful for aliases that then open up text editors, pagers, or the like. useful for aliases that then open up text editors, pagers, or the like.
To make an alias run in the foreground, decorate its To make an alias uncapturable, decorate its
function with the ``xonsh.proc.uncapturable`` decorator. This is probably function with the ``xonsh.proc.uncapturable`` decorator. This is probably
best used in conjunction with the ``unthreadable`` decorator. For example: best used in conjunction with the ``unthreadable`` decorator. For example: