Skip to content

Conversation

@mao-sz
Copy link
Contributor

@mao-sz mao-sz commented Jul 4, 2025

Because

Can't think of a situation where we actually want codespell to check URLs or emails. Example false flag of cryto in a URL: #29814

This PR

  • Configures codespell action to ignore words in URLs and emails.

Issue

Closes #29815

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project curriculum contributing guide
  • The title of this PR follows the location of change: brief description of change format, e.g. Intro to HTML and CSS lesson: Fix link text
  • The Because section summarizes the reason for this PR
  • The This PR section has a bullet point list describing the changes in this PR
  • If this PR addresses an open issue, it is linked in the Issue section
  • If any lesson files are included in this PR, they have been previewed with the Markdown preview tool to ensure it is formatted correctly
  • If any lesson files are included in this PR, they follow the Layout Style Guide

@mao-sz
Copy link
Contributor Author

mao-sz commented Jul 4, 2025

I may have choked on my drink getting the notification of codespell false positive with files untouched by this PR, and some in URLs as well. What irony...

Copy link
Member

@rlmoser99 rlmoser99 left a comment

Choose a reason for hiding this comment

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

I agree, we should exclude URIs and emails from spell checker. Thanks for taking the time to make this change!

@rlmoser99 rlmoser99 merged commit 236e0dc into TheOdinProject:main Jul 5, 2025
1 of 2 checks passed
@mao-sz mao-sz deleted the codespell-uri-email branch July 5, 2025 19:03
@mathdebate09
Copy link
Contributor

Hey Mao, I think the codespell still isn't ignoring the archive folder, for the newer codespell run on PR #29831

mao-sz added a commit to mao-sz/curriculum that referenced this pull request Jul 5, 2025
rlmoser99 pushed a commit that referenced this pull request Jul 5, 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.

Codespell: Ignore URIs and emails?

3 participants