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
fromnumpydoc.docscrapeimportNumpyDocStringdeffoo(x):
"""Function docstring. Parameters ---------- x: int Some description """NumpyDocString(foo.__doc__)["Parameters"]
Notice how the type of the parameter is empty! While the official syntax requires that the colon is preceded by a space, it's a typo that's very easy to miss and is very annoying in context of docstub. This case should be detected and either be warned about or handled gracefully.
The text was updated successfully, but these errors were encountered:
Related numpy/numpydoc#78. The general consensus seems to be to lint this prior with numpydoc lint. However, that linter doesn't seem to detect this specific issue.
Consider this docstring
returns
Notice how the type of the parameter is empty! While the official syntax requires that the colon is preceded by a space, it's a typo that's very easy to miss and is very annoying in context of docstub. This case should be detected and either be warned about or handled gracefully.
The text was updated successfully, but these errors were encountered: