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

Add note to docs that alias functions should start with underscores

Browse source 
See #1083.
This commit is contained in:
Aaron Meurer 2016-06-06 14:58:17 -04:00
parent 76ee929676
commit 8f56f02288
1 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/tutorial.rst
View file

@ -956,7 +956,7 @@ must have the following signature:
.. code-block:: python
def mycmd(args, stdin=None):
def _mycmd(args, stdin=None):
"""args will be a list of strings representing the arguments to this
command. stdin will be a string, if present. This is used to pipe
the output of the previous command into this one.
@ -996,10 +996,18 @@ built-in mapping. Here is an example using a function value:
.. code-block:: xonshcon
>>> aliases['banana'] = lambda args, stdin=None: ('My spoon is tooo big!', None)
>>> def _banana(args, stdin=None):
... return ('My spoon is tooo big!', None)
>>> aliases['banana'] = _banana
>>> banana
'My spoon is tooo big!'
.. note::
Alias functions should generally be defined with a leading underscore.
Otherwise, they may shadow the alias itself, as Python variables take
precedence over aliases when xonsh executes commands.
Usually, callable alias commands will be run in a separate thread so that
users may background them interactively. However, some aliases may need to be
executed on the thread that they were called from. This is mostly useful for debuggers
@ -1011,9 +1019,11 @@ with the ``xonsh.proc.foreground`` decorator.
from xonsh.proc import foreground
@foreground
def mycmd(args, stdin=None):
def _mycmd(args, stdin=None):
return 'In your face!'
aliases['mycmd'] = _mycmd
Aliasing is a powerful way that xonsh allows you to seamlessly interact to
with Python and subprocess.