From f1a41f2b1c34bae8360f5960921a58f3d8aee565 Mon Sep 17 00:00:00 2001 From: Leonardo Santagada Date: Fri, 22 Jul 2016 11:47:36 +0200 Subject: [PATCH] reformat paragraph and remove trailing whitespace --- CONTRIBUTING.rst | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 9f6b6ddab..6f6025408 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -19,16 +19,27 @@ develop xonsh. Making Your First Change ======================== -First, install xonsh from source and open a xonsh shell in your favorite terminal application. See installation instructions for details. +First, install xonsh from source and open a xonsh shell in your favorite +terminal application. See installation instructions for details. Next, make a trivial change (e.g. ``print("hello!")`` in ``main.py``). -Finally, run the following commands. You should see the effects of your change (e.g. ``hello!``):: +Finally, run the following commands. You should see the effects of your change +(e.g. ``hello!``):: $ $XONSH_DEBUG=1 $ xonsh -The xonsh build process collapses all Python source files into a single ``__amalgam__.py`` file. When xonsh is started with a falsy value for `$XONSH_DEBUG `_, it imports Python modules straight from ``__amalgam__.py``, which decreases startup times by eliminating the cost of runtime imports. But setting ``$ $XONSH_DEBUG=1`` will suppress amalgamated imports. Reloading the xonsh shell (``$ xonsh``) won't simply import the stale ``__amalgam__.py`` file that doesn't contain your new change, but will instead import the unamalgamated source code which does contain your change. You can now load every subsequent change by reloading xonsh, and if your code changes don't seem to have any effect, make sure you check ``$XONSH_DEBUG`` first! +The xonsh build process collapses all Python source files into a single +``__amalgam__.py`` file. When xonsh is started with a falsy value for +`$XONSH_DEBUG `_, it imports Python modules straight from +``__amalgam__.py``, which decreases startup times by eliminating the cost of +runtime imports. But setting ``$ $XONSH_DEBUG=1`` will suppress amalgamated +imports. Reloading the xonsh shell (``$ xonsh``) won't simply import the stale +``__amalgam__.py`` file that doesn't contain your new change, but will instead +import the unamalgamated source code which does contain your change. You can now +load every subsequent change by reloading xonsh, and if your code changes don't +seem to have any effect, make sure you check ``$XONSH_DEBUG`` first! Changelog @@ -185,7 +196,7 @@ Run all the tests using pytest:: $ py.test -q -Use "-q" to keep pytest from outputting a bunch of info for every test. +Use "-q" to keep pytest from outputting a bunch of info for every test. ---------------------------------- Running the Tests - Advanced