MAINT: Changed class constructor __init__ GL08 reporting #592
+134
−2
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changed
validate
function invalidate.py
for empty docstring errorGL08
("The object does not have a docstring"), specifically for__init__
constructors. If an empty docstring for__init__
, will first check if class docstring is satisfied for parameter mismatches, before deciding to reportGL08
(if mismatches exist, i.e. incomplete documentation).Implemented new docstring test classes in
test_validate.py
to verify correct functionality.Also updated readthedocs
format.rst
andvalidation.rst
to reflect new changes to constructor checking behavior.Solves #591.
Note, I think a modification to the readthedocs https://numpydoc.readthedocs.io/en/latest/validation.html#ignoring-validation-checks-with-inline-comments ought to be made
P.s. First time pull requesting to a public repo, let me know if anything is insufficient.