talmolab / sleap

A deep learning framework for multi-animal pose tracking.
https://sleap.ai
Other
435 stars 97 forks source link

Add codespell config, workflow and get it to fix some typos it finds #1610

Open yarikoptic opened 11 months ago

yarikoptic commented 11 months ago

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

coderabbitai[bot] commented 11 months ago

Walkthrough

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.

Changes

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?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips ### Chat There are 3 ways to chat with CodeRabbit's AI: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid.` - `@coderabbitai read the files in the src/scheduler package and generate README in the markdown format.` 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) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
codecov[bot] commented 11 months ago

Codecov Report

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:
Additional details and impacted files ```diff @@ 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 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

yarikoptic commented 5 months ago

if approved, should be merged?

FWIW - I have checked and it seems no new typos were added in develop since then.