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

add spell check for news and readme #1021

Merged
merged 4 commits into from
Apr 17, 2023

Conversation

vsoch
Copy link
Member

@vsoch vsoch commented Apr 6, 2023

Problem: the NEWS.md is not spell checked, and goes out to releases.
Solution: add a strong spell checker to be run on CI so we catch issues.

@chu11
Copy link
Member

chu11 commented Apr 6, 2023

similar to flux-framework/flux-core#5074 I'll try to fix up a ton of the typos in here too. There's a lot more false positives than in flux-core, so will have to go through it a little bit one by one :-( Don't have to necessarily fix all of them, just a good chunk.

@vsoch
Copy link
Member Author

vsoch commented Apr 7, 2023

Sounds good - thanks @chu11 ! Please push / edit this branch as you see fit.

@chu11
Copy link
Member

chu11 commented Apr 7, 2023

@vsoch similar the fixup in flux-core, could the commit be split into a typo fix commit and a CI fix. Thanks.

@vsoch
Copy link
Member Author

vsoch commented Apr 7, 2023

All set.

@chu11
Copy link
Member

chu11 commented Apr 7, 2023

i think you forgot to tweak title of the add spell check for news and readme commit. Perhaps just "NEWS.md: fix some typos" :-)

@vsoch
Copy link
Member Author

vsoch commented Apr 7, 2023

I didn’t forget, I thought it was OK. I think perfection of commit messages isn’t the best use of time, but since you asked I will change it!

The first I think was OK because when I ran the check I did check news and the README, but it didn’t find any issues in the README.

@chu11
Copy link
Member

chu11 commented Apr 7, 2023

I can't seem to add on top of the PR, wondering if i'm not counted as a "maintainer" on flux-sched. My commits can be yoinked from:

https://github.com/chu11/flux-sched/tree/add/spell-check

@grondo
Copy link
Contributor

grondo commented Apr 7, 2023

I think @vsoch has to add you as collaborator to researchapps...

@vsoch
Copy link
Member Author

vsoch commented Apr 7, 2023

Done! I invited all of you.

Copy link
Member

@jameshcorbett jameshcorbett left a comment

Choose a reason for hiding this comment

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

LGTM!

@@ -293,7 +293,7 @@ const std::vector<Resource> &dfu_impl_t::test (vtx_t u,
* For this case, when you visit the "node" resource vertex, the next
* Jobspec resource that should be used at the next recursion should
* be socket[1]. And we enable this if pristine is true.
* But then once the first match is made, any mis-mismatch afterwards
* But then once the first match is made, any miss-mismatch afterwards
Copy link
Member

Choose a reason for hiding this comment

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

I don't think I understand this either way...

Copy link
Contributor

Choose a reason for hiding this comment

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

The typo software stumbled here, seems like it should be "mismatch"

Copy link
Member

Choose a reason for hiding this comment

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

doh, i'll fix this up

@jameshcorbett jameshcorbett mentioned this pull request Apr 17, 2023
vsoch and others added 4 commits April 17, 2023 15:01
Problem: the NEWS.md has spelling errors, and goes out to releases.
Solution: fix spelling errors in NEWS.md
Signed-off-by: vsoch <vsoch@users.noreply.github.com>
Problem: we should automate spell checking
Solution: add spell check to CI
Signed-off-by: vsoch <vsoch@users.noreply.github.com>
Problem: The crate-ci typos tool found a ton of typos

Fix the typos!  Remove one misspelled word in test/spell.en.pws.
Problem: The function not_feasable() was misspelled.

Rename it to not_feasible() and update callers.
@chu11
Copy link
Member

chu11 commented Apr 17, 2023

fixed up that one remaining typo, force pushed it, hope that's ok!

setting MWP

@chu11 chu11 added the merge-when-passing mergify.io - merge PR automatically once CI passes label Apr 17, 2023
@codecov
Copy link

codecov bot commented Apr 17, 2023

Codecov Report

Merging #1021 (29a53bd) into master (2a9f8d9) will decrease coverage by 0.1%.
The diff coverage is 100.0%.

❗ Current head 29a53bd differs from pull request most recent head 79b11e5. Consider uploading reports for the commit 79b11e5 to get more accurate results

@@           Coverage Diff            @@
##           master   #1021     +/-   ##
========================================
- Coverage    74.3%   74.3%   -0.1%     
========================================
  Files          86      86             
  Lines        9434    9434             
========================================
- Hits         7018    7017      -1     
- Misses       2416    2417      +1     
Impacted Files Coverage Δ
qmanager/modules/qmanager_opts.hpp 100.0% <ø> (ø)
resource/evaluators/edge_eval_api.hpp 80.7% <ø> (ø)
resource/evaluators/expr_eval_vtx_target.hpp 100.0% <ø> (ø)
resource/evaluators/fold.hpp 14.2% <ø> (ø)
resource/modules/resource_match.cpp 72.0% <ø> (ø)
resource/modules/resource_match_opts.hpp 100.0% <ø> (ø)
resource/policies/base/dfu_match_cb.cpp 27.5% <ø> (ø)
resource/policies/base/matcher.cpp 69.7% <ø> (ø)
resource/traversers/dfu_impl.hpp 94.1% <ø> (ø)
resource/writers/match_writers.cpp 62.0% <ø> (ø)
... and 1 more

... and 1 file with indirect coverage changes

@mergify mergify bot merged commit 214aa27 into flux-framework:master Apr 17, 2023
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge-when-passing mergify.io - merge PR automatically once CI passes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants