Skip to content

Add codespell to pre-commit configuration #1001

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

Closed

Conversation

karta9821
Copy link
Contributor

Integrate codespell to prevent future typos.

@karta9821 karta9821 force-pushed the add-codespell-to-pre-commit branch from c08d0fa to 0b0dee0 Compare April 12, 2025 12:43
Copy link
Contributor

hyperlint-ai bot commented Apr 12, 2025

PR Change Summary

Integrated codespell into the pre-commit configuration to prevent future typos and made several updates to the documentation and release notes.

  • Added codespell to the pre-commit configuration
  • Updated release notes with new version information
  • Modified README to include logfire configuration
  • Improved documentation formatting for clarity

Modified Files

  • CHANGELOG.md
  • README.md
  • docs/how-to-guides/mcp-server.md

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@karta9821 karta9821 force-pushed the add-codespell-to-pre-commit branch from 0b0dee0 to 47c06de Compare April 12, 2025 12:44
Integrate codespell to prevent future typos.
Copy link

codecov bot commented Apr 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@alexmojaki
Copy link
Contributor

I tried this locally and got this:

tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:131: Sie ==> Size, Sigh, Side
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:179: Sie ==> Size, Sigh, Side
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:228: Sie ==> Size, Sigh, Side
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:231: Sie ==> Size, Sigh, Side
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:233: Sie ==> Size, Sigh, Side
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:235: Sie ==> Size, Sigh, Side
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:237: Sie ==> Size, Sigh, Side
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:277: Sie ==> Size, Sigh, Side
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:392: AAs ==> ass, as
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:394: ot ==> to, of, or, not, it
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:495: nD ==> and, 2nd
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:498: owEr ==> lower, owner, over
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:661: te ==> the, be, we, to
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:1308: wIl ==> will, well
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:1381: veW ==> view, vow, vex
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:1443: nD ==> and, 2nd
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:1490: ue ==> use, due
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:1528: TE ==> THE, BE, WE, TO
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:2126: FO ==> OF, FOR, TO, DO, GO
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:2127: uE ==> use, due
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:2356: oT ==> to, of, or, not, it
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:2785: AbD ==> and, bad
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:2823: nD ==> and, 2nd
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:2852: nD ==> and, 2nd
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:2889: agAi ==> again
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:2912: mAKs ==> mask, masks, makes, make
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:2952: nD ==> and, 2nd
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:2964: AhD ==> had, and
tests/otel_integrations/cassettes/test_openai_agents/test_voice_pipeline.yaml:3005: oT ==> to, of, or, not, it
tests/otel_integrations/cassettes/test_openai_agents/test_responses.yaml:47: yur ==> your
logfire-api/logfire_api/_internal/integrations/fastapi.pyi:26: dependant ==> dependent
logfire/_internal/integrations/fastapi.py:134: dependant ==> dependent
logfire/_internal/integrations/fastapi.py:139: dependant ==> dependent
logfire/_internal/integrations/fastapi.py:141: dependant ==> dependent
logfire/_internal/integrations/fastapi.py:141: dependant ==> dependent
logfire/_internal/integrations/fastapi.py:244: dependant ==> dependent
logfire/_internal/integrations/fastapi.py:248: dependant ==> dependent
logfire/_internal/integrations/fastapi.py:261: dependant ==> dependent
logfire/_internal/integrations/fastapi.py:261: dependant ==> dependent
tests/otel_integrations/test_openai_agents.py:3323: Sie ==> Size, Sigh, Side
tests/otel_integrations/test_openai_agents.py:3328: Sie ==> Size, Sigh, Side
tests/otel_integrations/test_openai_agents.py:3405: Sie ==> Size, Sigh, Side
tests/otel_integrations/test_openai_agents.py:3437: Sie ==> Size, Sigh, Side
tests/otel_integrations/test_openai_agents.py:3441: Sie ==> Size, Sigh, Side
tests/otel_integrations/test_openai_agents.py:3447: Sie ==> Size, Sigh, Side
tests/otel_integrations/test_openai_agents.py:3569: Sie ==> Size, Sigh, Side
tests/otel_integrations/test_openai_agents.py:3580: Sie ==> Size, Sigh, Side
tests/otel_integrations/test_openai_agents.py:3604: Sie ==> Size, Sigh, Side
tests/otel_integrations/test_openai_agents.py:3606: Sie ==> Size, Sigh, Side
CHANGELOG.md:248: asend ==> ascend, as end

These are all false positives.

@Kludex WDYT? We already have hyperlint, I'm not really keen for this.

@Kludex
Copy link
Member

Kludex commented Apr 14, 2025

Thanks for the PR @karta9821 , but I don't think this is necessary in this project.

As @alexmojaki said, we have hyperlint already, but more than that, I prefer to keep the minimal set of tools in the repository.

@Kludex Kludex closed this Apr 14, 2025
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.

3 participants