Skip to content

Fix typos in documentation and code comments#225

Merged
FanwangM merged 1 commit intotheochem:mainfrom
Ao-chuba:fix/typos
Feb 16, 2026
Merged

Fix typos in documentation and code comments#225
FanwangM merged 1 commit intotheochem:mainfrom
Ao-chuba:fix/typos

Conversation

@Ao-chuba
Copy link
Contributor

@tovrstra @PaulWAyers

- Fix 'qudratic' to 'quadratic' in pyproject.toml keywords
- Fix 'gauranteed' to 'guaranteed' in generic.py docstring
- Fix 'conver' to 'convert' in generic.py comment
- Remove commented-out dead code in generic.py
@PaulWAyers
Copy link
Member

Thanks @Ao-chuba . I've tagged the maintainer for Procrustes but if you don't get a review in the next few days, let me know and do it myself.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request addresses issue #224 by fixing multiple typos in documentation and code comments across the codebase. The changes include correcting misspellings in keywords metadata and improving code comment clarity by fixing typos and removing redundant commented-out code.

Changes:

  • Corrected 'qudratic' to 'quadratic' in project keywords
  • Fixed 'gauranteed' to 'guaranteed' in docstring
  • Fixed 'conver' to 'convert' in code comment
  • Removed duplicated commented-out code

Reviewed changes

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

File Description
pyproject.toml Fixed typo in keywords: 'qudratic' → 'quadratic' for "quadratic assignment problem"
procrustes/generic.py Corrected typos in docstring and comments; removed duplicate commented-out line

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

@Ao-chuba
Copy link
Contributor Author

@PaulWAyers, thank you for looping in the maintainer. Also whenever you get a chance could you please review the approach I suggested in the GSoC project idea proposal in the Grid repository? I’ve also raised a PR addressing an issue in the repo.
I'd really appreciate your feedback on those as well. Thank you for taking the time

Copy link
Collaborator

@FanwangM FanwangM left a comment

Choose a reason for hiding this comment

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

Thanks for the PR. It looks great to me. @Ao-chuba

@FanwangM FanwangM merged commit a0c02ce into theochem:main Feb 16, 2026
23 checks passed
@codecov
Copy link

codecov bot commented Feb 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@ba2ab64). Learn more about missing BASE report.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #225   +/-   ##
=======================================
  Coverage        ?   94.13%           
=======================================
  Files           ?       11           
  Lines           ?      802           
  Branches        ?        0           
=======================================
  Hits            ?      755           
  Misses          ?       47           
  Partials        ?        0           
Files with missing lines Coverage Δ
procrustes/generic.py 75.00% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

Fix Typos in Documentation, Keywords, and Comments

4 participants