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
@Josverl
Copy link
Contributor Author

Josverl commented Dec 7, 2025

Done

Copy link
Member

@dpgeorge dpgeorge 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 updating. Looks good now.

Add the codespell configuration based on the micropython/micropython repo.

Configuration added:
- pyproject.toml: codespell configuration with ignore-words stored in
  tools/ignore_words.txt and enabling of codespell ignore blocks.
- .github/workflows/codespell.yml: GitHub action runs on Push and PR.
- .pre-commit-config.yaml: runs codespell on commit.

Signed-off-by: Jos Verlinde <Jos.Verlinde@Microsoft.com>
Spelling preferences based on codespell configuration.

Signed-off-by: Jos Verlinde <Jos.Verlinde@Microsoft.com>
@dpgeorge dpgeorge merged commit c266d30 into micropython:master Dec 8, 2025
5 checks passed
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