Skip to content

Fixes spelling errors #1668

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

Merged
merged 3 commits into from
Jul 12, 2025
Merged

Fixes spelling errors #1668

merged 3 commits into from
Jul 12, 2025

Conversation

jacobslusser
Copy link
Contributor

@jacobslusser jacobslusser commented Jul 11, 2025

See #1269 for some relevant discussion

List of changes

  • Adds exclusion.dic file for spellchecker words to ignore
  • Updates .editorconfig(s) to configure VS spellchecker for the library and unit test projects
  • Fixes numerous misspelled words in comments, private members, and public members of test projects

NOTE: There is a misspelling of the ErrorOccured event in the Session class intentionally left unchanged because it is public-facing. Where we subscribe to that event via Session_ErrorOccurred, those instances are all private/internal and hence have been corrected.

Testing

All existing unit tests continue to pass.

Impact Analysis

None. No functional changes or public-facing APIs have been changed.

@@ -1,4 +1,7 @@
[*.cs]
spelling_languages = en-us,en-gb
spelling_exclusion_path = ../exclusion.dic
Copy link
Collaborator

Choose a reason for hiding this comment

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

the file this is pointing to has only 2 words, both already included in the top-level file. Is it an artifact of earlier changes?

Suggested change
spelling_exclusion_path = ../exclusion.dic
spelling_exclusion_path = ../../exclusion.dic

Copy link
Collaborator

Choose a reason for hiding this comment

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

this is the (redundant?) file I am talking about

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Another behavior (bug) in Visual Studio spellchecker. There were some times when it would honor the exclusion.dic file in the root and other times when it would only honor the one in the immediate same folder as the project/.editorconfig. From your fix, its possible I had my path wrong. Either way, I got tired of troubleshooting MS/VS issues and in the end tried to focus on the point of the PR which was to fix a few spelling errors, not necessarily build a spellchecking tool pipeline.

Copy link
Collaborator

Choose a reason for hiding this comment

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

sure, thanks

@Rob-Hague Rob-Hague merged commit 4886529 into sshnet:develop Jul 12, 2025
4 checks passed
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