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

Configure automatic spelling check via codespell within pre-commit #121

Merged
merged 5 commits into from
Oct 29, 2024

Conversation

bobleesj
Copy link
Contributor

Will add to the cookiecutter repo after further finding common terms to ignore in diffpy.srmise and diffpy.utils

Ref: Billingegroup/cookiecutter#168

@@ -9,8 +9,8 @@ Release Notes

**Fixed:**

* Updated REAMDE instructions for pip and conda-forge install
* Updated REAMDE instructions to check for successful installation
* Updated README instructions for pip and conda-forge install
Copy link
Contributor Author

Choose a reason for hiding this comment

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

typo found by codespell

@@ -127,7 +127,7 @@ trying to commit again.

Improvements and fixes are always appreciated.

Before contribuing, please read our `Code of Conduct <https://github.com/diffpy/diffpy.snmf/blob/main/CODE_OF_CONDUCT.rst>`_.
Before contributing, please read our `Code of Conduct <https://github.com/diffpy/diffpy.snmf/blob/main/CODE_OF_CONDUCT.rst>`_.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

typo found by codespell

@@ -1,6 +1,6 @@
.. _quick_start:

Tutorial (To be addded)
Tutorial (To be added)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

typo found by codespell

@@ -18,5 +18,5 @@ Add extra tutorials here
Bug Reports
===========

Please enjoy using our software! If you come accross any bugs in the
Please enjoy using our software! If you come across any bugs in the
Copy link
Contributor Author

Choose a reason for hiding this comment

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

typo found by codespell

[tool.codespell]
exclude-file = ".codespell/ignore_lines.txt"
ignore-words = ".codespell/ignore_words.txt"
skip = "*.cif"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

skip files

@@ -362,7 +362,7 @@ def update_weights_matrix(
The matrx containing the stretching factors of the calculated component signals. Has dimensions K x M
where K is the number of component signals and M is the number of XRD/PDF patterns.

component_matrix: 2d array lik
component_matrix: 2d array like
Copy link
Contributor Author

Choose a reason for hiding this comment

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

typo found by codespell

Copy link
Contributor Author

@bobleesj bobleesj left a comment

Choose a reason for hiding this comment

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

Ready for review! @sbillinge This is great.

@bobleesj bobleesj marked this pull request as ready for review October 29, 2024 03:07
@bobleesj
Copy link
Contributor Author

bobleesj commented Oct 29, 2024

I think the CI fails for 3.13, as expected. But please merge since it will be resolved once we have diffpy.utils 3.13 on feedstock.. soon

@sbillinge sbillinge merged commit fb8db49 into diffpy:main Oct 29, 2024
2 of 3 checks passed
@sbillinge
Copy link
Contributor

This is fantastic

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