DOC: RST definition list fixes #7626
Conversation
|
What happens if the colon is left in? Note that we don't use rst, the docstring format is converted before rendering and I wonder if that should be fixed to work with the colon all the time. Also, note the commit message formatting documented in @pv Thoughts? |
It's not rendered as a definition list anymore, such as http://docs.scipy.org/doc/scipy/reference/generated/scipy.integrate.quad.html#scipy.integrate.quad or in Numpy docs it adds an extraneous colon:
http://docs.scipy.org/doc/numpy-dev/reference/generated/numpy.polyfit.html There should only be a colon if there's a classifier after it. The indentation is what makes it a definition list, not the colon: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#definition-lists |
Definition lists are marked up with indentation, not colons, and extra colons break the web formatting
|
Perhaps (maybe file an issue to numpydoc tracker for this).
OTOH I don't see problems in merging this as a workaround.
|
|
Thanks @endolith . |
|
I opened an issue for numpydoc. |
also add a more obvious example to the HOWTO