-
Notifications
You must be signed in to change notification settings - Fork 71
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
Update terminal.py #231
Update terminal.py #231
Conversation
Attempt to make pylint happy with the kwargs documentation
Codecov Report
@@ Coverage Diff @@
## master #231 +/- ##
=======================================
Coverage 95.36% 95.36%
=======================================
Files 9 9
Lines 1014 1014
Branches 176 176
=======================================
Hits 967 967
Misses 43 43
Partials 4 4
Continue to review full report at Codecov.
|
I think pydocstyle wants to start the docstring with r""" if it has backslashes. |
Fix pycodestyle error. We'll see if this helps pylint as well.
Sorry about the obvious failure. I was being a little lazy, and just doing these updates through the web interface. (They seemed so simple, but I guess not.) |
Just confirmed locally that Sphinx does not like having the backslash removed. I investigated on the pylint side, and it looks like this is pylint-dev/pylint#5406. Thinking about what to do in terms of getting things to pass, my inclination would be to revert the changes to the docstring, and either version-lock pylint below |
I don't think we're in a hurry. Let's see what the Pylint guys say. They tend to fix things like this pretty quickly. If it becomes a blocker we'll just inline disable that check, but we can hold off for now. |
I just confirmed that the new pylint release passes accepts these changes, so this should be good to try again whenever. |
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.
Looks good to me
Attempt to make pylint happy with the kwargs documentation.
This line broke my other PR, so if this passes, it should be good.