numpydoc icon indicating copy to clipboard operation
numpydoc copied to clipboard

Published 20 hours ago • verified publisher icon numpy

ENH: Allow an empty string after the colon in variable descriptions in docstrings

Open charris opened this issue 8 years ago • 4 comments

See https://github.com/numpy/numpy/pull/7626 for examples

charris avatar May 12 '16 16:05 charris

Perhaps the solution here is to issue a warning.

jnothman avatar Sep 17 '17 04:09 jnothman

I'd say at least a warning, although an exception here is not unreasonable.

stefanv avatar Sep 17 '17 05:09 stefanv

Then we should take a similar stance to colon without a space before it, imo

jnothman avatar Sep 17 '17 06:09 jnothman

Warnings are probably safer for now then , since I believe we currently do compile that case without error.

On 16 September 2017 23:50:29 Joel Nothman [email protected] wrote:

Then we should take a similar stance to colon without a space before it, imo

-- You are receiving this because you commented. Reply to this email directly or view it on GitHub: https://github.com/numpy/numpydoc/issues/54#issuecomment-330024996

stefanv avatar Sep 17 '17 07:09 stefanv