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

Codespell infrastructure #3559

Merged
merged 2 commits into from
Oct 27, 2021
Merged

Codespell infrastructure #3559

merged 2 commits into from
Oct 27, 2021

Conversation

DimitriPapadopoulos
Copy link
Contributor

@DimitriPapadopoulos DimitriPapadopoulos commented Oct 26, 2021

Description

Codespell infrastructure as suggested in #3548 (comment).

Dear reviewer

I have added a commit with a very small set of typos in infrastructure files, they shouldn't get in the way of future PRs. I can remove it if you don't want it, but it's not very intrusive and fixes the typos that got in the way while preparing these PRs.

@DimitriPapadopoulos
Copy link
Contributor Author

For future reference codespell -w might help fix typos faster.

@DimitriPapadopoulos
Copy link
Contributor Author

Finally note that codespell works in a peculiar way: it doesn't operate with a dictionary of valid words, instead it operates with a dictionary of typos. So it might not catch unusual/new typos. Do not hesitate to contribute your own typos.

@DimitriPapadopoulos DimitriPapadopoulos mentioned this pull request Oct 26, 2021
@codecov
Copy link

codecov bot commented Oct 26, 2021

Codecov Report

Merging #3559 (df43850) into master (0292fd2) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #3559   +/-   ##
=======================================
  Coverage   93.87%   93.87%           
=======================================
  Files         159      159           
  Lines       19216    19216           
=======================================
  Hits        18039    18039           
  Misses       1177     1177           

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 0292fd2...df43850. Read the comment docs.

@adonath adonath self-assigned this Oct 26, 2021
@adonath adonath added this to the v0.19 milestone Oct 26, 2021
@adonath
Copy link
Member

adonath commented Oct 26, 2021

Thanks a lot @DimitriPapadopoulos! One last nitpicky comment: can you use either dashes or underscores consistently in the filenames of the ignore and exclude files? Otherwise this PR is ready from from my side.

@DimitriPapadopoulos
Copy link
Contributor Author

Should be OK now.

@adonath
Copy link
Member

adonath commented Oct 26, 2021

@DimitriPapadopoulos Now the commits adding the infrastructure are gone...

Run codespell from the root directory of the project as `codespell`.
Alternatively run `make codespell`, again from the root directory.

In both case it will pick up adequate options from setup.cfg.
@DimitriPapadopoulos
Copy link
Contributor Author

Ah, sorry about that. It's fixed now.

Copy link
Member

@adonath adonath left a comment

Choose a reason for hiding this comment

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

Thanks a lot @DimitriPapadopoulos! No further comments from my side...

@adonath adonath merged commit 021df28 into gammapy:master Oct 27, 2021
@DimitriPapadopoulos DimitriPapadopoulos deleted the codespell_infrastructure branch October 27, 2021 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants