-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Move some of the Numpy tests out of TestParamDocChecker
#5492
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Pull Request Test Coverage Report for Build 1555034207
π - Coveralls |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
π 100 lines less to maintain, again ! Great work !
@@ -0,0 +1,6 @@ | |||
"""Tests for missing-param-doc and missing-type-doc for Numpy style docstrings |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm curious, do you create this commit at the very end by rebasing and taking the value you had after moving everything ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Taken from missing_param_doc_required_Google
as they tend to have the same tests and thus similar ignores. I don't think there are any unnecessary ignores in here (and it doesn't really hurt if there are as long as they are not the messages we want to test)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ho alright, thank you for explaining :)
@@ -25,7 +25,6 @@ | |||
in particular the parameter documentation checker `DocstringChecker` | |||
""" | |||
|
|||
# pylint: disable=too-many-public-methods |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
π
@Pierre-Sassoulas I took another look at the remaining Basically, the numpy checker doesn't recognise property's correctly and recognises none of the |
Nice job finding the problem in tests ! Moving then fixing would permit to have a better history by just squashing both, but if it takes too much time I'm okay with mixing too. |
Moving>fixing is (nearly) impossible as I can't let the tests pass without fixing or accepting false positives. I'll have a look somewhere this week what the best effort/reward balance would be. |
Ok, I see the problem now, let's do both at the same time then, there's no point in fixing then moving it's more work for only theoretical benefit. |
@Pierre-Sassoulas The issue is more troublesome than I thought: This is a pretty naive approach at validating the docstrings. What happens for the remaining tests is that the https://github.com/PyCQA/pylint/blob/a51a5486ebff7543ae4fb6943fac2558947fa974/pylint/extensions/_check_docs_utils.py#L175-L184 To fix this we need to change how we validate docstrings. Something that takes into account when we match multiple types and then fixes the conflict between them. |
Type of Changes
Description
This does not cover all numpy tests as there are some issues with those that check
raise
documentation (it seems as if tests are incorrectly passing currently).Just to make the other PR easier to review, let's merge this first!