Skip to content
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

Replace underscores with spaces when running spell checker #1417

Merged
merged 1 commit into from
Apr 13, 2023

Conversation

vkbo
Copy link
Owner

@vkbo vkbo commented Apr 13, 2023

Summary:

Since underscores are considered word characters in regex, the spell checker has issues dealing with them when they are used for italics markup. This fix is a temporary solution until new spell checking code can be added, but it essentially just replaces all underscores with spaces before processing the word splitter regex used for spell checking.

The solution is simple, but carries a small overhead. Still, it is not an issue on normal sized documents.

Related Issue(s):

Closes #1415

Reviewer's Checklist:

  • The header of all files contain a reference to the repository license
  • The overall test coverage is increased or remains the same as before
  • All tests are passing
  • All flake8 checks are passing and the style guide is followed
  • Documentation (as docstrings) is complete and understandable
  • Only files that have been actively changed are committed

@vkbo vkbo added this to the Release 2.0.7 milestone Apr 13, 2023
@vkbo vkbo merged commit 6d0455b into main Apr 13, 2023
@vkbo vkbo deleted the fix/spell_underscore branch April 13, 2023 17:37
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.

Some markdown leads to spelling errors
1 participant