Stefan van der Walt

icon indicating a website link https://mentat.za.net

icon company University of California, Berkeley icon location Berkeley, CA icon location Everything Scientific Python. Works on NumPy, SciPy, scikit-image, NetworkX, etc. Author of Elegant SciPy. Researcher at UC Berkeley.

Results 328 comments of Stefan van der Walt

ENH: merge duplicate sections (rather than raise)

Thanks for clarifying that point. https://github.com/numpy/numpydoc/issues/68

Allow param lists to split on ': ' rather than ' : '

How about we split correctly but issue a warning?

Allow param lists to split on ': ' rather than ' : '

That grep script is truly horrific ;)

Allow param lists to split on ': ' rather than ' : '

So, if you have something that works, would fixing numpydoc still be useful to you, or should we just add that "fixer" into the README?

Allow param lists to split on ': ' rather than ' : '

I think this and other discussions around [similar requests](https://github.com/numpy/numpydoc/issues/68) has helped settle the issue in my mind: we should stick to one docstring format, and rather help those who want...

Allow param lists to split on ': ' rather than ' : '

The docstring format seems consistent? https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

Allow param lists to split on ': ' rather than ' : '

Thanks @jnothman, I'd be happy to review that.

Don't force 'returns' and 'raises' sections to be definition lists

In [0] the case of the single return value is discussed. You still have to provide a return type, don't you? [0] https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

Don't force 'returns' and 'raises' sections to be definition lists

I guess the question is whether this is any less clear or elegant: ``` Returns ------- string or dict The connection dictionary of the kernel. The type depends on `unpack`....

Don't force 'returns' and 'raises' sections to be definition lists

I'll let @pv and @rgommers chime in.