-
Notifications
You must be signed in to change notification settings - Fork 2
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
pylint/flake8: paths_cli.compiling
#59
pylint/flake8: paths_cli.compiling
#59
Conversation
Codecov Report
@@ Coverage Diff @@
## main #59 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 45 45
Lines 1766 1764 -2
=========================================
- Hits 1766 1764 -2
Continue to review full report at Codecov.
|
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.
LGTM, 1 question about a code change that seems like it is a bugfix and should probably be documented somewhere
class CategoryPlugin(OPSPlugin): | ||
""" | ||
Category plugins only need to be made for top-level | ||
""" | ||
def __init__(self, plugin_class, aliases=None, requires_ops=(1, 0), | ||
requires_cli=(0,4)): | ||
requires_cli=(0, 3)): |
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.
this seems like an actual bugfix? should this be mentioned somewhere?
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'd argue that it isn't a bugfix on the basis that it isn't in released code. However, I edited the main post of this PR to make mention of the change.
Now that my in-editor linter is working again, I went over the code in the
compiling
subpackage and cleaned up most of the things that registered as errors inpylint
andflake8
.I also used this as an excuse to start writing up a more detailed style guide for OpenPathSampling projects. I plan to put it in the main OPS developer docs as part of OPS 2.0 (it is Python 3 specific). The document is basically a list of "here are common cases where we allow exceptions to flake8/pylint errors and warnings" (basically, some guidelines as to when, IMHO, consistency becomes foolish consistency.)
Doc being developed in a gist: https://gist.github.com/dwhswenson/1361b849866af98e7f8e6599810670b2
EDIT: also fixes an incorrect version requirement in
CategoryPlugin
, which will be part of v0.3 (not v0.4 as I originally thought).