Skip to content

Teach CSpell to ignore hash links#2952

Merged
steve-fenton-octopus merged 1 commit into
mainfrom
sast/jrb/ignore-hash-links
Nov 26, 2025
Merged

Teach CSpell to ignore hash links#2952
steve-fenton-octopus merged 1 commit into
mainfrom
sast/jrb/ignore-hash-links

Conversation

@julietrb1
Copy link
Copy Markdown
Contributor

Our documentation uses syntax like {#server-configuration} to establish anchor links, but CSpell doesn't play well with this, and interprets the contents of such tags as spelling errors.

This commit ignores those tags by way of a regular expression to identify them. Hopefully this will mean a lot more passing PRs! 🥇

@julietrb1 julietrb1 self-assigned this Nov 26, 2025
Copy link
Copy Markdown
Contributor

@steve-fenton-octopus steve-fenton-octopus left a comment

Choose a reason for hiding this comment

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

Let's do it!

Note: I was gradually fixing these as they came up as these old bookmark links are long, use mixed case, and are generally not a nice thing to place in the address bar.

However, there are more impactful things to do, so we'll concede defeat on these (and fix them if we eyeball them).

@steve-fenton-octopus steve-fenton-octopus merged commit 3d369ad into main Nov 26, 2025
4 checks passed
@steve-fenton-octopus steve-fenton-octopus deleted the sast/jrb/ignore-hash-links branch November 26, 2025 08:31
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.

2 participants