diff --git a/docs/source/config/extensions.txt b/docs/source/config/extensions.txt index 2fbe39e..69284e3 100644 --- a/docs/source/config/extensions.txt +++ b/docs/source/config/extensions.txt @@ -50,7 +50,7 @@ to your configuration file:: 'myextension' ] -To load that same extension at runtime, use the ``%load_ext`` magic:: +To load that same extension at runtime, use the ``%load_ext`` magic: .. sourcecode:: ipython diff --git a/docs/source/config/overview.txt b/docs/source/config/overview.txt index 2c763bf..1c75b95 100644 --- a/docs/source/config/overview.txt +++ b/docs/source/config/overview.txt @@ -336,7 +336,7 @@ Let's start by showing how a profile is used: .. code-block:: bash - $ ipython profile=sympy + $ ipython --profile=sympy This tells the :command:`ipython` command line program to get its configuration from the "sympy" profile. The file names for various profiles do not change. The @@ -350,7 +350,7 @@ The general pattern is this: simply create a new profile with: ipython profile create which adds a directory called ``profile_`` to your IPython directory. Then -you can load this profile by adding ``profile=`` to your command line +you can load this profile by adding ``--profile=`` to your command line options. Profiles are supported by all IPython applications. IPython ships with some sample profiles in :file:`IPython/config/profile`. If @@ -374,7 +374,7 @@ object. Values are assigned in much the same way as in a config file: .. code-block:: bash - $> ipython InteractiveShell.use_readline=False BaseIPythonApplication.profile='myprofile' + $> ipython --InteractiveShell.use_readline=False --BaseIPythonApplication.profile='myprofile' Is the same as adding: @@ -394,9 +394,9 @@ used traits, so you don't have to specify the whole class name. For these **alia .. code-block:: bash - $> ipython profile='myprofile' + $> ipython --profile='myprofile' # is equivalent to - $> ipython BaseIPythonApplication.profile='myprofile' + $> ipython --BaseIPythonApplication.profile='myprofile' Flags ----- @@ -411,11 +411,11 @@ For instance: $> ipcontroller --debug # is equivalent to - $> ipcontroller Application.log_level=DEBUG + $> ipcontroller --Application.log_level=DEBUG # and $> ipython --pylab # is equivalent to - $> ipython pylab=auto + $> ipython --pylab=auto Subcommands ----------- @@ -427,14 +427,14 @@ Some IPython applications have **subcommands**. Subcommands are modeled after .. code-block:: bash - $> ipython qtconsole profile=myprofile + $> ipython qtconsole --profile=myprofile and :command:`ipcluster` is simply a wrapper for its various subcommands (start, stop, engines). .. code-block:: bash - $> ipcluster start profile=myprofile n=4 + $> ipcluster start --profile=myprofile --n=4 To see a list of the available aliases, flags, and subcommands for an IPython application, simply pass ``-h`` or ``--help``. And to see the full list of configurable options (*very* long), pass ``--help-all``. diff --git a/docs/source/development/testing.txt b/docs/source/development/testing.txt index abda16a..84a2c39 100644 --- a/docs/source/development/testing.txt +++ b/docs/source/development/testing.txt @@ -349,7 +349,8 @@ We basically need to be able to test the following types of code: Nose will pick them up as long as they conform to the (flexible) conventions used by nose to recognize tests. -2. Python files containing doctests. Here, we have two possibilities: +2. Python files containing doctests. Here, we have two possibilities: + - The prompts are the usual ``>>>`` and the input is pure Python. - The prompts are of the form ``In [1]:`` and the input can contain extended IPython expressions. @@ -361,6 +362,7 @@ We basically need to be able to test the following types of code: 3. ReStructuredText files that contain code blocks. For this type of file, we have three distinct possibilities for the code blocks: + - They use ``>>>`` prompts. - They use ``In [1]:`` prompts. - They are standalone blocks of pure Python code without any prompts.