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

chore/cleanups #9

Merged
merged 14 commits into from
Oct 29, 2023
Merged

chore/cleanups #9

merged 14 commits into from
Oct 29, 2023

Conversation

busticated
Copy link
Owner

@busticated busticated commented Oct 28, 2023

Description

Adds cargo xtask spellcheck task to find spelling mistakes in source code and docs across the workspace. Cleans up some typos and tunes interfaces and task output.

How to Test

  1. Clone and setup this branch locally (docs)
  2. Review the "How to check for spelling errors" How-To item
  3. Review available tasks: cargo xtask --help
  4. Add a typo to a source file and save (see note here and dictionary)
  5. Check for typos: cargo xtask spellcheck
  6. Undo your source file edit: git checkout -- <path-to-file>

Outcome

How-to entry should be clear and helpful, cargo xtask spellcheck task should flag "known" typos, code refactors should make sense.

Related / Discussions

#5

Completeness

  • PR opened 🎉
  • Testing instructions have been provided
  • Development How-To's have been provided
  • Docs have been updated (cargo xtask doc)
  • Branch is rebased against target (typically main)

Copy link
Owner Author

@busticated busticated left a comment

Choose a reason for hiding this comment

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

:shipit:

@busticated busticated merged commit 4e1ba00 into main Oct 29, 2023
@busticated busticated deleted the chore/cleanups branch October 29, 2023 02:30
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.

1 participant