Add codespell config, workflow and get it to fix some typos it finds #1610
Conversation
WalkthroughThe 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 Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit's AI:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files ignored due to filter (1)
- sleap/config/training_editor_form.yaml
Files selected for processing (38)
- .codespellrc (1 hunks)
- .github/workflows/codespell.yml (1 hunks)
- docs/CONTRIBUTING.md (1 hunks)
- docs/guides/cli.md (2 hunks)
- docs/guides/gui.md (1 hunks)
- docs/installation.md (2 hunks)
- docs/notebooks/Interactive_and_realtime_inference.ipynb (1 hunks)
- docs/notebooks/Interactive_and_resumable_training.ipynb (2 hunks)
- docs/notebooks/Training_and_inference_on_an_example_dataset.ipynb (3 hunks)
- docs/notebooks/Training_and_inference_using_Google_Drive.ipynb (1 hunks)
- pypi_requirements.txt (1 hunks)
- sleap/gui/app.py (3 hunks)
- sleap/gui/commands.py (4 hunks)
- sleap/gui/learning/dialog.py (1 hunks)
- sleap/gui/learning/runners.py (1 hunks)
- sleap/gui/overlays/tracks.py (1 hunks)
- sleap/gui/widgets/video.py (1 hunks)
- sleap/gui/widgets/views.py (1 hunks)
- sleap/instance.py (5 hunks)
- sleap/io/convert.py (1 hunks)
- sleap/io/dataset.py (3 hunks)
- sleap/io/format/ndx_pose.py (1 hunks)
- sleap/io/video.py (3 hunks)
- sleap/nn/architectures/resnet.py (1 hunks)
- sleap/nn/config/optimization.py (1 hunks)
- sleap/nn/data/resizing.py (1 hunks)
- sleap/nn/inference.py (1 hunks)
- sleap/nn/paf_grouping.py (1 hunks)
- sleap/nn/peak_finding.py (1 hunks)
- sleap/nn/tracking.py (2 hunks)
- sleap/nn/training.py (2 hunks)
- sleap/rangelist.py (1 hunks)
- sleap/skeleton.py (1 hunks)
- tests/gui/learning/test_dialog.py (1 hunks)
- tests/gui/test_commands.py (1 hunks)
- tests/info/test_h5.py (1 hunks)
- tests/nn/test_inference.py (1 hunks)
- tests/test_message.py (1 hunks)
Files skipped from review due to trivial changes (36)
- .codespellrc
- .github/workflows/codespell.yml
- docs/CONTRIBUTING.md
- docs/guides/cli.md
- docs/guides/gui.md
- docs/installation.md
- docs/notebooks/Interactive_and_realtime_inference.ipynb
- docs/notebooks/Interactive_and_resumable_training.ipynb
- docs/notebooks/Training_and_inference_on_an_example_dataset.ipynb
- docs/notebooks/Training_and_inference_using_Google_Drive.ipynb
- pypi_requirements.txt
- sleap/gui/app.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/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
Additional comments: 4
sleap/gui/commands.py (2)
1075-1080: The typo correction in the error message improves the readability and professionalism of the error handling.
2068-2074: The update to include detailed traceback information in the logging will be helpful for debugging purposes and understanding the context of errors.
sleap/io/dataset.py (2)
- 1883-1889: > Note: This review was outside the patches, and no patch overlapping with it was found. Original lines [15-18]
The typo corrections in the
to_dictmethod description are accurate and improve the readability of the documentation.
- 1883-1889: > Note: This review was outside the patches, and no patch overlapping with it was found. Original lines [22-22]
The typo corrections in the
export_nwbmethod description are accurate and improve the readability of the documentation.
sleap/gui/commands.py
Outdated
| def important(self): | ||
| """Imports AlphaTracker datasets.""" | ||
| self.execute(ImportAlphaTracker) |
There was a problem hiding this comment.
The method name important does not clearly indicate its functionality of importing datasets. Consider renaming it to something more descriptive, such as importAlphaTracker to maintain clarity and consistency.
- def important(self):
+ def importAlphaTracker(self):Committable suggestion
❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| def important(self): | |
| """Imports AlphaTracker datasets.""" | |
| self.execute(ImportAlphaTracker) | |
| def importAlphaTracker(self): | |
| """Imports AlphaTracker datasets.""" | |
| self.execute(ImportAlphaTracker) |
sleap/gui/commands.py
Outdated
| def importAT(self): | ||
| def important(self): |
There was a problem hiding this comment.
Everything looks pretty good except for renaming this function
There was a problem hiding this comment.
sorry, slipped through my fingers. Adding importat to skips, and redoing the fixes... force pushed
sleap/gui/app.py
Outdated
| self.commands.importAT, | ||
| self.commands.important, |
There was a problem hiding this comment.
Everything looks pretty good except for renaming this function
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w -i 3 -C 2",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
yarikoptic
force-pushed
the
enh-codespell
branch
from
903e1e2
to
a83e15d
Compare
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files ignored due to filter (1)
- sleap/config/training_editor_form.yaml
Files selected for processing (38)
- .codespellrc (1 hunks)
- .github/workflows/codespell.yml (1 hunks)
- docs/CONTRIBUTING.md (1 hunks)
- docs/guides/cli.md (2 hunks)
- docs/guides/gui.md (1 hunks)
- docs/installation.md (2 hunks)
- docs/notebooks/Interactive_and_realtime_inference.ipynb (1 hunks)
- docs/notebooks/Interactive_and_resumable_training.ipynb (2 hunks)
- docs/notebooks/Training_and_inference_on_an_example_dataset.ipynb (3 hunks)
- docs/notebooks/Training_and_inference_using_Google_Drive.ipynb (1 hunks)
- pypi_requirements.txt (1 hunks)
- sleap/gui/app.py (2 hunks)
- sleap/gui/commands.py (3 hunks)
- sleap/gui/learning/dialog.py (1 hunks)
- sleap/gui/learning/runners.py (1 hunks)
- sleap/gui/overlays/tracks.py (1 hunks)
- sleap/gui/widgets/video.py (1 hunks)
- sleap/gui/widgets/views.py (1 hunks)
- sleap/instance.py (5 hunks)
- sleap/io/convert.py (1 hunks)
- sleap/io/dataset.py (3 hunks)
- sleap/io/format/ndx_pose.py (1 hunks)
- sleap/io/video.py (3 hunks)
- sleap/nn/architectures/resnet.py (1 hunks)
- sleap/nn/config/optimization.py (1 hunks)
- sleap/nn/data/resizing.py (1 hunks)
- sleap/nn/inference.py (1 hunks)
- sleap/nn/paf_grouping.py (1 hunks)
- sleap/nn/peak_finding.py (1 hunks)
- sleap/nn/tracking.py (2 hunks)
- sleap/nn/training.py (2 hunks)
- sleap/rangelist.py (1 hunks)
- sleap/skeleton.py (1 hunks)
- tests/gui/learning/test_dialog.py (1 hunks)
- tests/gui/test_commands.py (1 hunks)
- tests/info/test_h5.py (1 hunks)
- tests/nn/test_inference.py (1 hunks)
- tests/test_message.py (1 hunks)
Files skipped from review due to trivial changes (37)
- .codespellrc
- .github/workflows/codespell.yml
- docs/CONTRIBUTING.md
- docs/guides/cli.md
- docs/guides/gui.md
- docs/installation.md
- docs/notebooks/Interactive_and_realtime_inference.ipynb
- docs/notebooks/Interactive_and_resumable_training.ipynb
- docs/notebooks/Training_and_inference_on_an_example_dataset.ipynb
- docs/notebooks/Training_and_inference_using_Google_Drive.ipynb
- pypi_requirements.txt
- sleap/gui/app.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
Additional comments: 3
sleap/gui/commands.py (3)
1074-1080: The typo in the error message has been corrected.
1240-1246: The logic for handling the export of analysis files appears to be correct.
2068-2074: The typo in the log message has been corrected.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #1610 +/- ##
===========================================
- Coverage 73.38% 73.38% -0.01%
===========================================
Files 134 134
Lines 24064 24064
===========================================
- Hits 17660 17659 -1
- Misses 6404 6405 +1 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (2)
- sleap/gui/learning/dialog.py (1 hunks)
- sleap/io/video.py (3 hunks)
Files skipped from review due to trivial changes (2)
- sleap/gui/learning/dialog.py
- sleap/io/video.py
|
if approved, should be merged? FWIW - I have checked and it seems no new typos were added in |
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!
❤️
Summary by CodeRabbit
Documentation
Bug Fixes
Chores
codespellto ignore certain files and patterns, reducing false positives during spell checks.Style
Tests