Skip to content
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

Start using codespell #81

Merged

Conversation

WilliamJamieson
Copy link
Collaborator

codespell is a tool which is designed to check for misspelled words in source code. This PR sets up a reasonable configuration for codespell, fixes all the errors codespell uncovered, and adds codespell to the basic style checks for stpipe. Note that codespell can both autofix many common misspellings and be configured to ignore some misspellings by adding words to the ignore-words-list in the pyproject.toml file.

Note that this PR is built on top of the changes in #80 and so should be merged after PR #80

@codecov
Copy link

codecov bot commented Jan 9, 2023

Codecov Report

Patch coverage has no change and project coverage change: -54.04 ⚠️

Comparison is base (d8b2f93) 54.03% compared to head (69fd4f1) 0.00%.

❗ Current head 69fd4f1 differs from pull request most recent head 1359c3c. Consider uploading reports for the commit 1359c3c to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #81       +/-   ##
==========================================
- Coverage   54.03%   0.00%   -54.04%     
==========================================
  Files          25      25               
  Lines        3046    3055        +9     
==========================================
- Hits         1646       0     -1646     
- Misses       1400    3055     +1655     
Impacted Files Coverage Δ
src/stpipe/__init__.py 0.00% <0.00%> (-100.00%) ⬇️
src/stpipe/__main__.py 0.00% <ø> (-100.00%) ⬇️
src/stpipe/cli/__init__.py 0.00% <ø> (-100.00%) ⬇️
src/stpipe/cli/command.py 0.00% <ø> (-72.73%) ⬇️
src/stpipe/cli/list.py 0.00% <0.00%> (-97.30%) ⬇️
src/stpipe/cli/main.py 0.00% <0.00%> (-87.18%) ⬇️
src/stpipe/cmdline.py 0.00% <0.00%> (-64.34%) ⬇️
src/stpipe/config.py 0.00% <0.00%> (-58.54%) ⬇️
src/stpipe/config_parser.py 0.00% <0.00%> (-70.62%) ⬇️
src/stpipe/crds_client.py 0.00% <0.00%> (-32.56%) ⬇️
... and 15 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@WilliamJamieson WilliamJamieson marked this pull request as ready for review April 11, 2023 15:18
@WilliamJamieson WilliamJamieson requested a review from a team as a code owner April 11, 2023 15:18
Copy link
Collaborator

@zacharyburnett zacharyburnett left a comment

Choose a reason for hiding this comment

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

This means I misspelled "precedence" across multiple repos haha

@WilliamJamieson
Copy link
Collaborator Author

This means I misspelled "precedence" across multiple repos haha

We should probably enable codespell on everything that has a pre-commit configuration. It is nice to have external verification of spelling.

@WilliamJamieson WilliamJamieson merged commit 5bec1ec into spacetelescope:master Apr 11, 2023
@WilliamJamieson WilliamJamieson deleted the feature/use_codespell branch April 11, 2023 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants