[IPython-dev] Bug in our magic_arguments decorator for building docstrings (ping R. Kern)?

Fernando Perez fperez.net@gmail....
Tue Sep 4 15:05:31 CDT 2012


On Tue, Sep 4, 2012 at 5:52 AM, Hans Meine <hans_meine@gmx.net> wrote:

> Has this been fixed, or is there a GH issue for this problem?

Fixed here:

commit 673e53310ce16220ccc235eb0da56df9f654df4f
Merge: 29dc2c6 df97f2d
Author: Fernando Perez <fernando.perez@berkeley.edu>
Date:   Mon Jun 11 21:14:18 2012 -0700

    Merge pull request #1921 from bfroehle/_1890_magic_arguments_docstring

    magic_arguments: dedent but otherwise preserve indentation.

    Previously magic_arguments stripped all whitespace at the
beginning of each line, interferi
ng with formatting syntax which relies on indentation to give context
(e.g., code blocks). Now
the docstring text is passed through dedent to strip the global
indentation before being handed
 off to `RawDescriptionHelpFormatter` which preserves any remaining indentation.

    Thanks to @rkern for suggesting the solution approach.

    Closes gh-1890.


More information about the IPython-dev mailing list