##// END OF EJS Templates
Backport PR #4209: Magic doc fixes...
Thomas Kluyver -
Show More
@@ -4,9 +4,18 b''
4 Cython related magics
4 Cython related magics
5 =====================
5 =====================
6
6
7 Magic command interface for interactive work with Cython
8
9 .. note::
10
11 The ``Cython`` package needs to be installed separately. It
12 can be obtained using ``easy_install`` or ``pip``.
13
7 Usage
14 Usage
8 =====
15 =====
9
16
17 To enable the magics below, execute ``%load_ext cythonmagic``.
18
10 ``%%cython``
19 ``%%cython``
11
20
12 {CYTHON_DOC}
21 {CYTHON_DOC}
@@ -11,9 +11,13 b' Magics for interacting with Octave via oct2py.'
11 The ``oct2py`` module needs to be installed separately and
11 The ``oct2py`` module needs to be installed separately and
12 can be obtained using ``easy_install`` or ``pip``.
12 can be obtained using ``easy_install`` or ``pip``.
13
13
14 You will also need a working copy of GNU Octave.
15
14 Usage
16 Usage
15 =====
17 =====
16
18
19 To enable the magics below, execute ``%load_ext octavemagic``.
20
17 ``%octave``
21 ``%octave``
18
22
19 {OCTAVE_DOC}
23 {OCTAVE_DOC}
@@ -6,9 +6,18 b' Rmagic'
6
6
7 Magic command interface for interactive work with R via rpy2
7 Magic command interface for interactive work with R via rpy2
8
8
9 .. note::
10
11 The ``rpy2`` package needs to be installed separately. It
12 can be obtained using ``easy_install`` or ``pip``.
13
14 You will also need a working copy of R.
15
9 Usage
16 Usage
10 =====
17 =====
11
18
19 To enable the magics below, execute ``%load_ext rmagic``.
20
12 ``%R``
21 ``%R``
13
22
14 {R_DOC}
23 {R_DOC}
@@ -464,19 +473,19 b' class RMagics(Magics):'
464 * If the cell is not None, the magic returns None.
473 * If the cell is not None, the magic returns None.
465
474
466 * If the cell evaluates as False, the resulting value is returned
475 * If the cell evaluates as False, the resulting value is returned
467 unless the final line prints something to the console, in
476 unless the final line prints something to the console, in
468 which case None is returned.
477 which case None is returned.
469
478
470 * If the final line results in a NULL value when evaluated
479 * If the final line results in a NULL value when evaluated
471 by rpy2, then None is returned.
480 by rpy2, then None is returned.
472
481
473 * No attempt is made to convert the final value to a structured array.
482 * No attempt is made to convert the final value to a structured array.
474 Use the --dataframe flag or %Rget to push / return a structured array.
483 Use the --dataframe flag or %Rget to push / return a structured array.
475
484
476 * If the -n flag is present, there is no return value.
485 * If the -n flag is present, there is no return value.
477
486
478 * A trailing ';' will also result in no return value as the last
487 * A trailing ';' will also result in no return value as the last
479 value in the line is an empty string.
488 value in the line is an empty string.
480
489
481 The --dataframe argument will attempt to return structured arrays.
490 The --dataframe argument will attempt to return structured arrays.
482 This is useful for dataframes with
491 This is useful for dataframes with
General Comments 0
You need to be logged in to leave comments. Login now