-
Notifications
You must be signed in to change notification settings - Fork 579
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
FEAT: Add docstring check to CI for an initial subset files #1996
FEAT: Add docstring check to CI for an initial subset files #1996
Conversation
e78905b
to
0554d46
Compare
c9ab8e6
to
d37c27a
Compare
d37c27a
to
89a5dd1
Compare
I will try each week to fix docstring for some backend (addressed in new PRs). |
89a5dd1
to
55ff381
Compare
The tests are failing with |
thanks @toryhaavik I am working on that. it is missing the quotes. thanks! |
all the tests passed now :) |
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.
Thanks @xmnlab this is great work!
@@ -17,6 +20,12 @@ | |||
|
|||
@pytest.fixture(scope='module') | |||
def con(): | |||
"""Define a connection fixture. |
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.
we may want to consider loosening the restriction for test code. you shouldn't necessarily need to write a docstring for a test method
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.
IIRC the default for match
parameter exclude tests for the checking. I just add that to help people to understand easily (as much as possible) the tests. not sure if it is the right direction ...
also there is an issue related to the documentation and tests experiences: #1989
thanks for the review and the merge @toryhaavik ! |
In this PR:
Current issues with pydocstyle: