Fix typos found by codespell - #138
Conversation
📝 WalkthroughWalkthroughThis 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
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
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
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. Comment |
There was a problem hiding this comment.
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
left a comment
There was a problem hiding this comment.
Looks good thanks for the PR!
Not all typos were fixed. Some of them occur in very long lines, making diffs impossible to read.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.