Skip to content

Fix/spelling#4519

Open
galenseilis wants to merge 4 commits intoManimCommunity:mainfrom
galenseilis:fix/spelling
Open

Fix/spelling#4519
galenseilis wants to merge 4 commits intoManimCommunity:mainfrom
galenseilis:fix/spelling

Conversation

@galenseilis
Copy link

Overview: What does this pull request change?

  • Fixed typos detected by typos-cli.
  • Add typos-cli configuration for removing false positives in spell check detection.

Motivation and Explanation: Why and how do your changes improve the library?

I decided to spend a little bit of time familiarizing myself with Manim. One of the ways to do that is to spend some time making relatively safe changes like fixing spelling. I used the typos-cli to find potential issues, manually evaluated if the potential issues are actually issues, and made changes accordingly. I use the Pyright LSP rename utility so that names would be changed consistently.

Links to added or changed documentation pages

All of the typos were minor implementation changes that I don't expect to noticeably change in the documentation. If anything, some API docs will change but I did not check.

Further Information and Comments

Reviewer Checklist

  • The PR title is descriptive enough for the changelog, and the PR is labeled correctly
  • If applicable: newly added non-private functions and classes have a docstring including a short summary and a PARAMETERS section
  • If applicable: newly added functions and classes are tested

@behackl
Copy link
Member

behackl commented Jan 11, 2026

To make this somewhat sustainable, we'd need to add this sort of check to pre-commit or the code quality pipeline. I'm not really convinced it is worth to add another dependency with another config file for this. Can this tool also be configured within pyproject.toml?

PointND and VectorND are false-positives. Can you elaborate on why you had to add Nam and OT?

Copy link
Member

@behackl behackl left a comment

Choose a reason for hiding this comment

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

See comment above

@galenseilis
Copy link
Author

@behackl

To make this somewhat sustainable, we'd need to add this sort of check to pre-commit or the code quality pipeline. I'm not really convinced it is worth to add another dependency with another config file for this.

  • One option is to delete the _typos.toml but keep the spelling corrections.

Can this tool also be configured within pyproject.toml?

  • I have not tried it yet, but purportedly pyproject.toml is supported.

PointND and VectorND are false-positives. Can you elaborate on why you had to add Nam and OT?

  • They're there b/c typos was recommended something incorrect. I don't remember the message it gave now, but I can check.

@behackl
Copy link
Member

behackl commented Jan 19, 2026

Okay. In the meantime I checked, we already have codespell in our pre-commit, so I'm against adding a second spellchecker tool. The config file should be removed from this PR.

As for the other changes, I'm leaning towards merging them (even though they are effectively breaking changes).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 🆕 New

Development

Successfully merging this pull request may close these issues.

2 participants