Repository navigation
docs: fix the grammar and spelling findings from the PyCharm inspection - #98
Merged
Merged
Conversation
Correct the hyphenation, article and capitalisation findings in code comments and docs. Use <br/> instead of \n for line breaks in the Mermaid labels of Docs/code_flow.md, which renders the same and stops the spell checker reading words like 'nasset'. Rename vfig to volume_fig. Add proper nouns and diagram node IDs to the project dictionary.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Fix the grammar and spelling findings from the PyCharm inspection:
<br/>instead of\nin the Mermaid labels ofDocs/code_flow.md. GitHub renders them the same, and the spell checker no longer reads words likenasset.vfigtovolume_fig.scan.pydocstring with a pointer toDocs/variable_list.md, which documents every field.Checks
ruff check .,mypy pulseengine/andpytestpass on this commit by itself.