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

Spellcheck the repo #167

Merged
merged 13 commits into from
May 6, 2024
Merged

Spellcheck the repo #167

merged 13 commits into from
May 6, 2024

Conversation

sjspielman
Copy link
Member

Closes #164

Spellchecking the repo! Filing as a draft to first catch and fix the spelling errors.

@sjspielman sjspielman marked this pull request as ready for review May 6, 2024 17:05
@sjspielman
Copy link
Member Author

This is now ready for review. As part of review, please weigh in on:

  • Do we want to keep the GHA checking all these files? (maybe we can remove the files argument altogether at this point?)
  • If we do not want to do ^, I could also remove the partial words from the dictionary, e.g. ual derived from manual.

@sjspielman sjspielman requested a review from jashapiro May 6, 2024 17:07
Copy link
Member

@jashapiro jashapiro left a comment

Choose a reason for hiding this comment

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

LGTM. I'd probably just check all files to keep things simpler. I suggested another way to exclude files from checks if we want to do that.

Othere than that, just a few minor comments.

@@ -28,7 +28,7 @@ jobs:
id: spell
with:
dictionary: components/dictionary.txt
files: "docs/* docs/*/*"
files: "docs/* docs/*/* workshop_materials/cheatsheets/* instructor_notes/* instructor_notes/openscpca/* "
Copy link
Member

Choose a reason for hiding this comment

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

I'd probably just remove this at this point and check everything. I'm not too worried about the partial words added being a problem.

I also thought of another thing we could if we want to exclude particular files: add a step with rm for the files we want the spellchecker to skip.

components/dictionary.txt Outdated Show resolved Hide resolved
instructor_notes/06_shell-scripting.md Outdated Show resolved Hide resolved
components/dictionary.txt Outdated Show resolved Hide resolved
components/dictionary.txt Outdated Show resolved Hide resolved
@sjspielman sjspielman merged commit b0cd0e3 into main May 6, 2024
1 check passed
@sjspielman sjspielman deleted the sjspielman/164-spellcheck branch May 6, 2024 19:35
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.

Spell check the repo
2 participants