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

Add codespell spelling/typo linter and fix errors #556

Merged
merged 4 commits into from
Aug 18, 2024

Conversation

cclauss
Copy link
Contributor

@cclauss cclauss commented Aug 13, 2024

https://pypi.org/project/codespell

% codespell --ignore-words-list=aas,socio-economic,toi

./ATTRIBUTION.rst:102: accomodate ==> accommodate
./icepyx/core/APIformatting.py:246: formated ==> formatted
./icepyx/core/APIformatting.py:323: formated ==> formatted
./icepyx/core/APIformatting.py:343: formated ==> formatted
./icepyx/core/auth.py:52: initializatin ==> initialization
./icepyx/core/query.py:453: depracation ==> deprecation
./icepyx/core/query.py:725: funtionality ==> functionality
./icepyx/core/read.py:167: flexiblity ==> flexibility
./icepyx/core/variables.py:440: conjuction ==> conjunction
./icepyx/core/variables.py:454: heirarchy ==> hierarchy
./icepyx/core/variables.py:455: availble ==> available
./icepyx/core/variables.py:548: heirarchy ==> hierarchy
./icepyx/tests/test_granules.py:33: extention ==> extension
./icepyx/tests/test_quest.py:18: Paramaterize ==> Parameterize
./icepyx/tests/test_quest_argo.py:247: pres ==> press
./icepyx/quest/quest.py:160: requred ==> required
./doc/source/example_notebooks/IS2_DEM_comparison_WIP.ipynb:84: depedencies ==> dependencies
./doc/source/example_notebooks/IS2_DEM_comparison_WIP.ipynb:268: opertaions ==> operations
./doc/source/example_notebooks/IS2_DEM_comparison_WIP.ipynb:319: retrive ==> retrieve
./doc/source/example_notebooks/IS2_DEM_comparison_WIP.ipynb:441: avaialable ==> available
./doc/source/example_notebooks/IS2_DEM_comparison_WIP.ipynb:744: Pipline ==> Pipeline
./doc/source/example_notebooks/IS2_DEM_comparison_WIP.ipynb:764: Pipline ==> Pipeline
./doc/source/example_notebooks/IS2_DEM_comparison_WIP.ipynb:870: acquisiton ==> acquisition
./doc/source/example_notebooks/IS2_cloud_data_access.ipynb:355: recieve ==> receive
./doc/source/example_notebooks/IS2_data_access.ipynb:488: decribed ==> described
./doc/source/example_notebooks/IS2_data_access.ipynb:507: continous ==> continuous
./doc/source/example_notebooks/IS2_data_read-in.ipynb:18: delimeter ==> delimiter
./doc/source/example_notebooks/IS2_data_variables.ipynb:281: availble ==> available
./doc/source/example_notebooks/IS2_data_variables.ipynb:363: heirarchy ==> hierarchy
./doc/source/example_notebooks/IS2_data_variables.ipynb:890: Simlarly ==> Similarly
./doc/source/example_notebooks/IS2_data_visualization.ipynb:141: splited ==> split
./doc/source/contributing/icepyx_internals.rst:16: explicity ==> explicitly
./doc/source/community/resources/2020_IS2_HW.rst:10: accomodate ==> accommodate

% codespell --ignore-words-list=aas,socio-economic,toi --write-changes

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link

github-actions bot commented Aug 13, 2024

Binder 👈 Launch a binder notebook on this branch for commit 47f20b3

I will automatically update this comment whenever this PR is modified

Binder 👈 Launch a binder notebook on this branch for commit b23c999

Binder 👈 Launch a binder notebook on this branch for commit 72415ac

Binder 👈 Launch a binder notebook on this branch for commit 3ec08c1

Binder 👈 Launch a binder notebook on this branch for commit be9954f

Binder 👈 Launch a binder notebook on this branch for commit 2ef15d1

Binder 👈 Launch a binder notebook on this branch for commit cbd8def

Binder 👈 Launch a binder notebook on this branch for commit b1e01c1

Binder 👈 Launch a binder notebook on this branch for commit 0512d2f

Binder 👈 Launch a binder notebook on this branch for commit 9986b95

@mfisher87
Copy link
Member

Awesome, thank you for this! What do you think of adding codespell as a pre-commit check?

Copy link
Member

@mfisher87 mfisher87 left a comment

Choose a reason for hiding this comment

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

LGTM!

code_of_conduct.md Outdated Show resolved Hide resolved
Comment on lines +68 to +70
[tool.codespell]
ignore-words-list = "aas,socio-economic,toi"

Copy link
Member

Choose a reason for hiding this comment

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

I think there was talk about alphabetizing within pyproject.toml, which I'd be in support of so it's easier to find if a given tool is already there.

Copy link
Contributor Author

@cclauss cclauss Aug 14, 2024

Choose a reason for hiding this comment

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

setuptools is so central to Python packaging that I have always seen it before all other tools so that is why I placed codespell just after it.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks for the explanation! Totally makes sense on the order then.

it was requested to be reverted back out.

So then is #557 needed?

Copy link
Member

Choose a reason for hiding this comment

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

#557 is still providing a validator even though the formatting part of it was removed 🚀

Copy link
Member

@JessicaS11 JessicaS11 left a comment

Choose a reason for hiding this comment

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

My inner editor is very excited about this PR!

@cclauss cclauss requested a review from weiji14 August 17, 2024 05:23
@mfisher87 mfisher87 changed the title Fix typos discovered by codespell Add codespell spelling/typo linter and fix errors Aug 18, 2024
@mfisher87 mfisher87 merged commit 8ef252c into icesat2py:development Aug 18, 2024
5 checks passed
@mfisher87
Copy link
Member

Thanks @cclauss 🚀

@cclauss cclauss deleted the codespell branch August 18, 2024 17:03
Copy link

codecov bot commented Aug 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.07%. Comparing base (a259f9a) to head (9986b95).
Report is 38 commits behind head on development.

Additional details and impacted files
@@             Coverage Diff              @@
##           development     #556   +/-   ##
============================================
  Coverage        65.07%   65.07%           
============================================
  Files               36       36           
  Lines             3052     3052           
  Branches           538      538           
============================================
  Hits              1986     1986           
  Misses             981      981           
  Partials            85       85           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.

4 participants