Skip to content

Conversation

@dwhswenson
Copy link
Member

@dwhswenson dwhswenson commented Nov 4, 2021

This performs the pylint/flake8 cleanup for the wizard subpackage requested in #57. Mainly this involved removing some unused imports and unused code and adding a lot of docstrings.

The Wizard API is still expected to be in a state of rapid flux (even after the v0.3 release) so some parameters that are likely to be removed are not always documented, and some methods that are likely to be removed are only partly documented. I also marked a few things as likely to change in the near future.

Code style exceptions to pylint/flake8 rules here: https://gist.github.com/dwhswenson/1361b849866af98e7f8e6599810670b2

@dwhswenson dwhswenson mentioned this pull request Nov 4, 2021
18 tasks
@codecov
Copy link

codecov bot commented Nov 4, 2021

Codecov Report

Merging #66 (3fb1571) into main (68fc7de) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##              main       #66    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files           52        58     +6     
  Lines         2185      2293   +108     
==========================================
+ Hits          2185      2293   +108     
Impacted Files Coverage Δ
paths_cli/wizard/engines.py 100.00% <ø> (ø)
paths_cli/wizard/joke.py 100.00% <ø> (ø)
paths_cli/wizard/load_from_ops.py 100.00% <ø> (ø)
paths_cli/wizard/run_module.py 100.00% <ø> (ø)
paths_cli/wizard/standard_categories.py 100.00% <ø> (ø)
paths_cli/wizard/steps.py 100.00% <ø> (ø)
paths_cli/wizard/tools.py 100.00% <ø> (ø)
paths_cli/wizard/tps.py 100.00% <ø> (ø)
paths_cli/wizard/core.py 100.00% <100.00%> (ø)
paths_cli/wizard/cvs.py 100.00% <100.00%> (ø)
... and 20 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 68fc7de...3fb1571. Read the comment docs.

@dwhswenson
Copy link
Member Author

This is ready for review and comment. I will leave it open for at least 24 hours, merging no earlier than Fri 05 Nov 15:00 GMT (11:00 my local).

Copy link
Member

@sroet sroet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One question about handling capitalization in one of the errors that I noticed, otherwise LGTM

Copy link
Member

@sroet sroet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dwhswenson dwhswenson merged commit 539c8b0 into openpathsampling:main Nov 5, 2021
@dwhswenson dwhswenson deleted the pylint-wizard branch November 5, 2021 18:37
@dwhswenson dwhswenson mentioned this pull request Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants