Skip to content

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

Merged
sbillinge merged 5 commits intodiffpy:mainfrom
bobleesj:spelling
Oct 29, 2024
Merged

Configure automatic spelling check via codespell within pre-commit#121
sbillinge merged 5 commits intodiffpy:mainfrom
bobleesj:spelling

Conversation

@bobleesj
Copy link
Copy Markdown
Contributor

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

Ref: scikit-package/scikit-package#168


* 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
Copy Markdown
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

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
Copy Markdown
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

.. _quick_start:

Tutorial (To be addded)
Tutorial (To be added)
Copy link
Copy Markdown
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

===========

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
Copy Markdown
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
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

skip files

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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
@sbillinge
Copy link
Copy Markdown
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