[Python-modules-team] Bug#608942: Bug#608942: python-matplotlib-doc: spaces in arguments of Sphinx ":param" field

Sandro Tosi morph at debian.org
Thu Jan 13 06:37:10 UTC 2011


Hi Jakub,
thanks for your report!

On Tue, Jan 4, 2011 at 20:47, Jakub Wilk <jwilk at debian.org> wrote:
> In Sphinx 1.0, ":param" field can accept up to 2 whitespace-separated
> arguments. Unforunately, this new feature breaks a bit documentation of some
> stuff in the mpl_toolkits.axes_grid.axes_divider module, which is using
> spaces for its own purpose:
>
> $ grep -E -r 'param [^ ]* [^ ]*:' .
> ./lib/mpl_toolkits/axes_grid/axes_divider.py:        :param nx, nx1:
> Integers specifying the column-position of the
> ./lib/mpl_toolkits/axes_grid/axes_divider.py:        :param ny, ny1: same as
> nx and nx1, but for row positions.
> ./lib/mpl_toolkits/axes_grid/axes_divider.py:        :param nx, nx1:
> Integers specifying the column-position of the
> ./lib/mpl_toolkits/axes_grid/axes_divider.py:        :param ny, ny1: same as
> nx and nx1, but for row positions.
> ./lib/mpl_toolkits/axes_grid/axes_divider.py:        :param nx, nx1:
> Integers specifying the column-position of the
> ./lib/mpl_toolkits/axes_grid/axes_divider.py:        :param ny, ny1: same as
> nx and nx1, but for row positions.

Do you know if there is some trick to make the space be used, maybe
something like 'nx,\ nx1' or &nbsp; or some other magic? Else I'll
just drop the space and write 'nx,nx1' (that I've verified it works as
expected, even if a bit less visually pleasant).

Cheers,
-- 
Sandro Tosi (aka morph, morpheus, matrixhasu)
My website: http://matrixhasu.altervista.org/
Me at Debian: http://wiki.debian.org/SandroTosi





More information about the Python-modules-team mailing list