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

Added support for RST and TXT files #16

Merged
merged 1 commit into from
Feb 9, 2023
Merged

Conversation

dave3d
Copy link
Member

@dave3d dave3d commented Feb 8, 2023

Basically, for RST and TXT files we skip the comment parsing section, and simply pass each line of the files to the spell checker.

Also, more comments were added to the code.

Basically, for RST and TXT files we skip the comment parsing section,
and simply pass each line of the files to the spell checker.

Also, more comments were added to the code.
@dave3d dave3d requested review from blowekamp and zivy February 8, 2023 17:55
Copy link
Member

@zivy zivy left a comment

Choose a reason for hiding this comment

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

Does this need to deal with rst markup somehow or is it sufficient to treat that as regular words and the user may need to add some that are not words into the exception/additional dictionary?

@dave3d
Copy link
Member Author

dave3d commented Feb 8, 2023

Does this need to deal with rst markup somehow or is it sufficient to treat that as regular words and the user may need to add some that are not words into the exception/additional dictionary?

Yeah, it doesn't properly deal with RST markup keywords. I'm going to add those keywords to the SimpleITK dictionary.

@zivy
Copy link
Member

zivy commented Feb 8, 2023

Valid choice, just add this to the documentation, something along the lines of:
"reStructuredText, .rst, files are treated as standard text. Consequentially, all markup keywords that are not actual words will need to be added to the additional/exception dictionary."

@dave3d dave3d merged commit f010dce into SimpleITK:main Feb 9, 2023
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