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

Jakub Wilk jwilk at debian.org
Tue Jan 4 19:47:56 UTC 2011


Package: python-matplotlib-doc
Version: 0.99.3-1
Severity: minor
User: python-modules-team at lists.alioth.debian.org
Usertags: sphinx1.0

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.


[0] See bottom of:
http://sphinx.pocoo.org/domains.html#info-field-lists

-- 
Jakub Wilk





More information about the Python-modules-team mailing list