Skip to content

Add a spelling ignore role#199

Merged
mergify[bot] merged 6 commits intosphinx-contrib:masterfrom
grhm:spelling-ignore-role
Nov 13, 2022
Merged

Add a spelling ignore role#199
mergify[bot] merged 6 commits intosphinx-contrib:masterfrom
grhm:spelling-ignore-role

Conversation

@grhm
Copy link
Copy Markdown
Contributor

@grhm grhm commented Nov 12, 2022

This is an attempt to add a :spelling:ignore: role that allows a particular word, or phrase, to be ignored by the spelling checker but only in this location.

It does not add the word to the list of good words. Any other occurrences of the word elsewhere will be flagged as spelling errors. (Unless it is actually spelt correctly of course).

This fixes #198.

Copy link
Copy Markdown
Member

@dhellmann dhellmann left a comment

Choose a reason for hiding this comment

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

This looks good. I'll add to the docs and prepare a release.

@mergify mergify bot merged commit 139596b into sphinx-contrib:master Nov 13, 2022
@dhellmann
Copy link
Copy Markdown
Member

This enhancement is included in release 7.7.0

@dhellmann
Copy link
Copy Markdown
Member

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Question - Confusion over spelling:word role

2 participants