Open yarikoptic opened 11 months ago
The changes encompass a wide range of typographical error corrections across various documentation, comments, and error messages within the codebase. Additionally, a GitHub Actions workflow for spell checking using codespell
has been introduced, ensuring future contributions are free from such mistakes. Minor clarifications in help texts and comments have been made to improve understanding and readability.
File Path | Change Summary |
---|---|
.codespellrc ,.github/workflows/codespell.yml |
Added codespell configuration and GitHub Actions workflow for spell checking. |
docs/CONTRIBUTING.md ,docs/guides/cli.md ,docs/guides/gui.md ,docs/installation.md ,docs/notebooks/... ,pypi_requirements.txt ,sleap/gui/app.py ,sleap/gui/commands.py ,sleap/gui/learning/dialog.py ,sleap/gui/learning/runners.py ,sleap/gui/overlays/tracks.py ,sleap/gui/widgets/video.py ,sleap/gui/widgets/views.py ,sleap/instance.py ,sleap/io/convert.py ,sleap/io/dataset.py ,sleap/io/format/ndx_pose.py ,sleap/io/video.py ,sleap/nn/architectures/resnet.py ,sleap/nn/config/optimization.py ,sleap/nn/data/resizing.py ,sleap/nn/inference.py ,sleap/nn/paf_grouping.py ,sleap/nn/peak_finding.py ,sleap/nn/tracking.py ,sleap/nn/training.py ,sleap/rangelist.py ,sleap/skeleton.py ,tests/gui/learning/test_dialog.py ,tests/gui/test_commands.py ,tests/info/test_h5.py ,tests/nn/test_inference.py ,tests/test_message.py |
Corrected typographical errors and clarified comments and documentation. |
"In the burrow of the code, where the characters hop,
A spell was cast, and typos did stop.
🐇 With each keystroke, and every line,
The rabbit ensured the words would align."
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Attention: Patch coverage is 0%
with 2 lines
in your changes missing coverage. Please review.
Project coverage is 73.38%. Comparing base (
14b5b78
) to head (fc06c95
). Report is 36 commits behind head on develop.
Files | Patch % | Lines |
---|---|---|
sleap/gui/app.py | 0.00% | 1 Missing :warning: |
sleap/nn/training.py | 0.00% | 1 Missing :warning: |
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
if approved, should be merged?
FWIW - I have checked and it seems no new typos were added in develop
since then.
Description
codespell is great, and it can help to keep your code typos free.
Types of changes
Outside contributors checklist
Thank you for contributing to SLEAP!
:heart:
Summary by CodeRabbit
Documentation
Bug Fixes
Chores
codespell
to ignore certain files and patterns, reducing false positives during spell checks.Style
Tests