Skip to content

Document PyPI installation and pre-commit setup - #75

Merged
dave3d merged 2 commits into
mainfrom
copilot/simpleitk-72-add-installation-instructions
Nov 19, 2026
Merged

dave3d merged 2 commits into
mainfrom
copilot/simpleitk-72-add-installation-instructions

Conversation

@dave3d

@dave3d dave3d commented Nov 17, 2026 •

Copy link
Copy Markdown
Member

The README did not explain how to install CommentSpellCheck or use it as a pre-commit hook.

  • PyPI: Add python -m pip install comment-spell-check instructions.
  • Usage: Update the example to run the installed comment_spell_check command.
  • Pre-commit: Document repository-based setup pinned to a release tag.
repos:
- repo: https://github.com/SimpleITK/CommentSpellCheck
  rev: vX.Y.Z
  hooks:
  - id: comment-spell-check

Copilot AI linked an issue Nov 17, 2026 that may be closed by this pull request
@dave3d dave3d changed the title [WIP] Add installation instructions for package in README Document PyPI installation and pre-commit setup Nov 17, 2026
@dave3d
dave3d requested a balanced review from Copilot November 17, 2026 18:34

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟢 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_check command.
  • 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

Comment thread requirements.txt Outdated
comment_parser
pyspellchecker
bibtexparser
bibtexparser<2

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Any reason for this constraint and not changing the spellchecker code to 2.x? I recently made the move to 2 as that is the recommended version per the reamde.

dave3d and others added 2 commits November 19, 2026 16:44
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
@dave3d
dave3d force-pushed the copilot/simpleitk-72-add-installation-instructions branch from d8bda4f to c40f02b Compare November 19, 2026 16:45
@dave3d
dave3d requested a review from zivy November 19, 2026 16:56
@dave3d
dave3d merged commit 856531d into main Nov 19, 2026
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.

missing instructions on how to install package

4 participants