Skip to content

Conversation

@Josverl
Copy link
Contributor

@Josverl Josverl commented Nov 18, 2025

Add the codespell configuration based on the micropython/micropython repo.
this was triggered by recent fixes and a comment from Damien

  • Configuration added:
    • pyproject.toml
      Codespell configuration with:
      • ignore-words stored in tools/ignore_words.txt
      • enablement of codespell ignore blocks
    • codespell.yml
      GitHub action runs on Push and PR
    • .pre-commit-config.yaml
      runs codespell on commit.
  • The 2nd commit contains spelling corrections in comments , docstrings , and .md files based on the above configuration
  • 3rd commit is the only code change. The requests module has a typo in the name a a variable (formated --> formatted)
    While this is a minor code change I did bump the version for that module.

Example:

# This will be checked

# codespell:ignore-begin

# this part wil not be cheked

# codespell:ignore-end

Testing

Tested locally and in CI

Labeled as Docs- as there is no 🔨tools label

@Josverl Josverl requested a review from dpgeorge November 18, 2025 17:27
@Josverl Josverl added the docs label Nov 18, 2025
@Josverl Josverl force-pushed the chore_codespell branch 2 times, most recently from d108cc8 to 09160fd Compare November 18, 2025 17:39
Signed-off-by: Jos Verlinde <Jos.Verlinde@Microsoft.com>
#
# Generally endpoint STALL is handled automatically, but there are some
# device classes that need to explicitly stall or unstall an endpoint
# device classes that need to explicitly stall or uninstall an endpoint
Copy link
Member

Choose a reason for hiding this comment

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

This needs to stay as "unstall" because it's the opposite of "stall".

Maybe changing it to "un-stall" would be best? It seems that codespell doesn't complain about "un-stall".

Copy link
Contributor Author

@Josverl Josverl Dec 7, 2025

Choose a reason for hiding this comment

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

Ah, that was what was intended.
Un-stall does make more sense to me as a non-native speaker.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@Josverl Josverl requested a review from dpgeorge December 7, 2025 13:37
Spelling preferences based on codespell configuration.

Signed-off-by: Jos Verlinde <Jos.Verlinde@Microsoft.com>
@Josverl
Copy link
Contributor Author

Josverl commented Dec 7, 2025

Done

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants