Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace codespell global ignore with line-specific ignores #2451

Open
freakboy3742 opened this issue Mar 11, 2024 · 0 comments
Open

Replace codespell global ignore with line-specific ignores #2451

freakboy3742 opened this issue Mar 11, 2024 · 0 comments
Labels
bug A crash or error in behavior.

Comments

@freakboy3742
Copy link
Member

Describe the bug

The top-level pyproject.toml includes a codespell configuration that adds a global ignore-words-list. This is because codespell is incorrectly identifying some words as misspellings. Ideally, we'd use a per-usage ignore, rather than a global ignore.

This was logged as codespell-project/codespell#1212, which was implemented as codespell-project/codespell#2400. We should use the new feature in Toga.

Steps to reproduce

  1. Disable the ignore-words-list configuration in the top level pyproject.toml
  2. Run pre-commit run --all

Expected behavior

Pre-commit should pass the codespell test without error.

Screenshots

No response

Environment

Pre-commit/CI.

Logs


Additional context

Our codespell dependency is set at v2.2.6 at time of writing. When a new version of codespell is released, our pre-commit update task will automatically upgrade the version, at which point we can replace the ignore-words-list global config with per-line ignores (e.g., # codespell:ignore crate)for the specific places where there is a problem.

@freakboy3742 freakboy3742 added the bug A crash or error in behavior. label Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug A crash or error in behavior.
Projects
None yet
Development

No branches or pull requests

1 participant