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
{{ message }}
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.
Notes
The observed behaviour is obviously related to the way pydocstyle is designed. In checker.py, concretely in def check_docstring_sections method, it is not known anymore which convention has been chosen (similar to that error codes to check for are not known, but only evaluated once ConventionChecker().check_source(source, filename,ignore_decorators) has been completed.).
Because of that, it is currently not possible to check for required sections and since D417 is only raised by the _check_parameters_section (numpy) or the _check_args_section (google), which however are not called if none of the possible sections is provided (see example 1), _check_missing_args will not be called. This is also related to #394 and its associated PR #407.
The text was updated successfully, but these errors were encountered:
The following example (1) does not raise a D417:
The following example (2) properly raises a D417:
Note the s appended to the
Parameter
section.Content of setup.cfg
Expected behaviour
I expect the first example to raise a D417 or to raise an error stating that the section does not comply to numpy format.
Related issues
#406
#319
#459
Notes
The observed behaviour is obviously related to the way pydocstyle is designed. In
checker.py
, concretely indef check_docstring_sections method
, it is not known anymore which convention has been chosen (similar to that error codes to check for are not known, but only evaluated onceConventionChecker().check_source(source, filename,ignore_decorators)
has been completed.).Because of that, it is currently not possible to check for required sections and since D417 is only raised by the
_check_parameters_section
(numpy) or the_check_args_section
(google), which however are not called if none of the possible sections is provided (see example 1),_check_missing_args
will not be called. This is also related to #394 and its associated PR #407.The text was updated successfully, but these errors were encountered: