Skip to content

Fix typos found by codespell - #138

Merged
singjc merged 2 commits into
OpenMS:mainfrom
DimitriPapadopoulos:codespell
Jan 17, 2026
Merged

Fix typos found by codespell#138
singjc merged 2 commits into
OpenMS:mainfrom
DimitriPapadopoulos:codespell

Conversation

@DimitriPapadopoulos

@DimitriPapadopoulos DimitriPapadopoulos commented Jan 16, 2026

Copy link
Copy Markdown
Contributor

Not all typos were fixed. Some of them occur in very long lines, making diffs impossible to read.

Summary by CodeRabbit

  • Documentation
    • Fixed numerous typos and improved wording across README, guides, notebooks, and gallery examples for clarity.
    • Expanded supported plots table to include Mobilogram, Spectrum, PeakMap 2D, and PeakMap 3D.
    • Added an explicit environment activation step and clarified installation instructions.
    • Corrected docstrings and comments for clearer developer-facing documentation.

✏️ Tip: You can customize this high-level summary in your review settings.

Copilot AI review requested due to automatic review settings January 16, 2026 13:25
@coderabbitai

coderabbitai Bot commented Jan 16, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

This pull request corrects numerous typographical and spelling errors across documentation, notebooks, gallery scripts, and source docstrings. README gets an explicit environment activation step and an expanded Supported Plots table. No functional logic, control flow, or public API signatures were changed.

Changes

Cohort / File(s) Summary
README
README.md
Fix typos ("Suported" → "Supported", "environemnt" → "environment"), add explicit conda activate pyopenms_viz step, expand Supported Plots table with Mobilogram, Spectrum, PeakMap 2D, PeakMap 3D rows
Notebooks
docs/Getting Started.ipynb, nbs/Spectrum.ipynb
Multiple markdown and inline comment spelling/phrasing corrections (e.g., "Avalible" → "Available", "iteractive" → "interactive", "seperate" → "separate") — content-only edits
Docs config & gallery
docs/conf.py, docs/gallery_scripts_template/plot_spectrum.py
Comment typo fixes ("indendation" → "indentation", "annoations" → "annotations") — no behavior changes
Source docstrings & comments
pyopenms_viz/_core.py, pyopenms_viz/_matplotlib/core.py
Docstring/comment typo fixes ("relevent" → "relevant", "Wether" → "Whether", "priorty" → "priority", "heigh" → "height") — no API or logic changes

Sequence Diagram(s)

(omitted — changes are documentation and comment fixes without new cross-component control flow)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • jcharkow

Poem

🐰 A hop, a fix, a polish bright,
I chased the typos through the night.
"Supported" trimmed, "environment" neat,
Docs now tip-toe on steady feet.
A rabbit's whisker, tidy and light. 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Fix typos found by codespell' accurately describes the main change: systematic typo corrections across multiple files in the repository.
Docstring Coverage ✅ Passed Docstring coverage is 80.00% which is sufficient. The required threshold is 80.00%.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR fixes spelling errors identified by codespell across Python source files, Jupyter notebooks, documentation, and README. The changes correct various typos in comments, docstrings, and documentation without modifying any functional code.

Changes:

  • Fixed 9 spelling errors across 6 files in comments, docstrings, and documentation
  • Corrected common typos: "heigh" → "height", "relevent" → "relevant", "Wether" → "Whether", "priorty" → "priority", "annoation(s)" → "annotation(s)", "indendation" → "indentation", "Suported" → "Supported", "environemnt" → "environment"

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
pyopenms_viz/_matplotlib/core.py Fixed typo "heigh" → "height" in TODO comment
pyopenms_viz/_core.py Fixed three typos: "relevent" → "relevant", "Wether" → "Whether", "priorty" → "priority" in docstrings and comments
nbs/Spectrum.ipynb Fixed two typos: "annoation" → "annotation" and "annoations" → "annotations" in code comments
docs/gallery_scripts_template/plot_spectrum.py Fixed typo "annoations" → "annotations" in code comment
docs/conf.py Fixed typo "indendation" → "indentation" in code comment
README.md Fixed two typos: "Suported" → "Supported" and "environemnt" → "environment" in documentation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@jcharkow jcharkow left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good thanks for the PR!

@singjc
singjc enabled auto-merge January 17, 2026 16:00
@singjc
singjc merged commit d20b740 into OpenMS:main Jan 17, 2026
7 of 9 checks passed
@DimitriPapadopoulos
DimitriPapadopoulos deleted the codespell branch January 17, 2026 17:27
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.

4 participants