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
At the moment, the NumpydocParser only looks at the description of a parameter to find its default value (relevant code).
However, the numpydoc style guide also allows specifying the default value as part of the type (source):
Optional keyword parameters have default values, which are displayed as part of the function signature. They can also be detailed in the description: [...] or as part of the type, instead of optional. If the default value would not be used as a value, optional is preferred. These are all equivalent:
At the moment, the
NumpydocParser
only looks at the description of a parameter to find its default value (relevant code).However, the
numpydoc
style guide also allows specifying the default value as part of the type (source):This is, for example, used by scikit-learn.
Moreover, the default value should be removed from the
type_name
property ofDocstringParam
, just likeoptional
.The text was updated successfully, but these errors were encountered: