Repository navigation
Conversation
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues were identified for the documentation-only installation and pre-commit setup updates.
No open issues 🎉
What changed in this PR
This documentation-only PR addresses issue #72 by explaining how to install CommentSpellCheck and configure it as a pre-commit hook.
Changes:
- Adds PyPI installation instructions using
python -m pip. - Updates the usage example to invoke the installed
comment_spell_checkcommand. - Documents repository-based pre-commit setup pinned to a release tag, without requiring a separate PyPI installation.
| File | Description |
|---|---|
| README.md | Adds installation and pre-commit instructions and updates the command-line usage example. |
Review effort: Balanced
dave3d
marked this pull request as ready for review
November 17, 2026 18:46
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README did not explain how to install CommentSpellCheck or use it as a pre-commit hook.
python -m pip install comment-spell-checkinstructions.comment_spell_checkcommand.