Pyspelling configuration improvements for URL and image link exclusion #139
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
DariuszPorowski
approved these changes
Jan 23, 2026
kachawla
reviewed
Jan 23, 2026
Contributor
kachawla
left a comment
kachawla
left a comment
There was a problem hiding this comment.
@brooke-hamilton this makes sense to me, but I was wondering if this will cause us to skip misspelled image file names?
ytimocin
approved these changes
Jan 23, 2026
Member
Author
Yes, it's a tradeoff in terms of having to either allow misspelled words in image names vs having to add things like "kHTPUX" to the dictionary. I'm open to further refinement of this for sure. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves the pyspelling configuration to reduce false positives during spell checking by excluding URLs and markdown image links.
Changes
Modified file:
.github/config/.pyspelling.ymlpyspelling.filters.urlfilter to exclude URLs from spell checkingThese filters prevent the spell checker from flagging file paths in image links and URLs as misspelled words.
Testing
On the main branch of this repo, follow the README.md instructions to run
pyspellingon your machine, like this:pyspelling --verbose --config ./.github/config/.pyspelling.yml`Observer several spelling errors.
Change to the branch for this PR, and test again. You should see the errors do not exist.