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

Merge sphinx spelling list with VSCode's Code Spelling version #4149

Merged
merged 3 commits into from
Jul 18, 2023

Conversation

nllong
Copy link
Member

@nllong nllong commented Jul 17, 2023

Any background context you want to provide?

VSCode has a valuable extension for spell-checking the source code and comments (Code Spell Checker). Furthermore, we haven't been enforcing the spell checks that run in the make html step.

What's this PR do?

  • Move the spelling list from docs/source to .cspell
  • Add many allowed words
  • replace all ie with i.e.,
  • pin pyyaml to latest version to fix cython installation

How should this be manually tested?

Unit tests will suffice.

What are the relevant tickets?

n/a

Screenshots (if appropriate)

@github-actions
Copy link

Label error. Requires at least 1 of: Feature, Bug, Enhancement, Maintenance, Documentation, Performance, Do not publish. Found:

@nllong nllong changed the title merge sphinx spelling list with VSCode cspell, fix spelling issues Merge sphinx spelling list with VSCode's Code Spelling version Jul 17, 2023
@nllong nllong requested a review from axelstudios July 18, 2023 01:30
@@ -22,7 +22,7 @@ similar designation without specific prior written permission from the U.S. Depa

(5) The name of the copyright holder(s), any contributors, the United States Government, the
United States Department of Energy, or any of their employees may not be used to endorse or
romote products derived from this software without specific prior written permission from the
promote products derived from this software without specific prior written permission from the
Copy link
Member Author

Choose a reason for hiding this comment

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

romote? 🤦‍♂️

@axelstudios axelstudios merged commit 0fc09f0 into develop Jul 18, 2023
7 checks passed
@axelstudios axelstudios deleted the spelling-lists branch July 18, 2023 01:39
dhaley pushed a commit that referenced this pull request Jul 21, 2023
* merge sphinx spelling list with VSCode cspell, fix spelling issues

* favor nginx over NGINX

* bump version of pyyaml to pin cython
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.

None yet

2 participants