You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
defreturn_none(number: int) ->None:
""" Return None. Parameters ---------- number This is an argument. Returns ------- None """number+=1returnNone
numpydoc validation fails with the error:
+-----------------+------------------+---------+---------------------------------+
| file | item | check | description |
+=================+==================+=========+=================================+
| test.py:1 | test.return_none | RT03 | Return value has no description |
+-----------------+------------------+---------+---------------------------------+
Does the numpydoc spec actually expect return None to have a value description in the docstring? I can't find any examples of this or what the description is supposed to be. All the examples I see show no docstring description for None in this circumstance.
What should this description look like? Or is the validator in the wrong?
The text was updated successfully, but these errors were encountered:
If I have a function like:
numpydoc validation fails with the error:
Does the numpydoc spec actually expect
return None
to have a value description in the docstring? I can't find any examples of this or what the description is supposed to be. All the examples I see show no docstring description forNone
in this circumstance.What should this description look like? Or is the validator in the wrong?
The text was updated successfully, but these errors were encountered: