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

add codespell config, workflow (just to detect typos) and have some typos fixed #70

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

yarikoptic
Copy link

@yarikoptic yarikoptic commented Nov 28, 2023

Summary by CodeRabbit

  • Documentation

    • Corrected spelling errors in various documentation and comments for improved clarity and professionalism.
  • Chores

    • Implemented a GitHub Actions workflow to automatically check for spelling errors in the codebase on pushes and pull requests.

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
Copy link
Contributor

coderabbitai bot commented Nov 28, 2023

Walkthrough

The changes across various files in the codebase are primarily focused on correcting spelling errors. These corrections are found in comments, documentation, and markdown files, ensuring clarity and professionalism. A GitHub Actions workflow has also been introduced to automate the detection of spelling mistakes, further maintaining the quality of the codebase.

Changes

File Path Change Summary
.github/workflows/codespell.yml Added a GitHub Actions workflow for spell checking.
CONTRIBUTING.md
sleap_io/io/labelstudio.py
sleap_io/io/nwb.py
sleap_io/model/instance.py
tests/io/test_nwb.py
tests/model/test_instance.py
Corrected various spelling errors in documentation and comments.

🐇✨
A hop of letters, a skip of words,
CodeRabbit fixed the typos, now the prose sings like birds.
With each push and pull, the spell check will run,
Ensuring the code's as clear as the sun. 🌞📝


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Note: For conversation with the bot, please use the review comments on code diffs or files.

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.
  • 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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 9a04f7f and fa49609.
Files ignored due to filter (1)
  • pyproject.toml
Files selected for processing (7)
  • .github/workflows/codespell.yml (1 hunks)
  • CONTRIBUTING.md (1 hunks)
  • sleap_io/io/labelstudio.py (1 hunks)
  • sleap_io/io/nwb.py (3 hunks)
  • sleap_io/model/instance.py (2 hunks)
  • tests/io/test_nwb.py (1 hunks)
  • tests/model/test_instance.py (1 hunks)
Files skipped from review due to trivial changes (6)
  • CONTRIBUTING.md
  • sleap_io/io/labelstudio.py
  • sleap_io/io/nwb.py
  • sleap_io/model/instance.py
  • tests/io/test_nwb.py
  • tests/model/test_instance.py
Additional comments: 1
.github/workflows/codespell.yml (1)
  • 1-22: The GitHub Actions workflow for Codespell is correctly set up and should work as intended when triggered by pushes and pull requests to the main branch.

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.

1 participant