Spelling

[jsoref]

This PR corrects misspellings identified by the check-spelling action (which is an evolution of the script I used ages ago when I first made a PR here...).

The misspellings have been reported at https://github.com/jsoref/CLI11/actions/runs/12194174338#summary-34017587518

The action reports that the changes in this PR would make it happy: https://github.com/jsoref/CLI11/actions/runs/12194174680#summary-34017588281

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.98%. Comparing base (e4ee3af) to head (bdd12bf).
Report is 58 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##              main    #1101      +/-   ##
===========================================
- Coverage   100.00%   99.98%   -0.02%     
===========================================
  Files           17       17              
  Lines         4546     5019     +473     
  Branches         0     1026    +1026     
===========================================
+ Hits          4546     5018     +472     
- Misses           0        1       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jsoref]

this is a little different from most changes and is very manual (all changes are manual, but this is more so). I'm happy to drop it or anything else, but I think it kinda helps to clarify that the second part describes the first.

[jsoref]

I'm fairly certain this is the correct person's name, but I'm not really sure where this code comes from -- I'd love to fix the source material.

[phlptp]

The original is here https://github.com/bilke/cmake-modules/blob/master/CodeCoverage.cmake

[jsoref]

Thanks. I posted https://github.com/bilke/cmake-modules/pull/90/files#r1878500171 to upstream this fix.

[jsoref]

I think adding the - isn't unreasonable...

[jsoref]

Notably, this appears to be a broken guard

[phlptp]

hmmm

[phlptp]

this is probably triggering the coverage issue, meaning some bits of code were never run

[jsoref]

Yeah, the extra coverage in https://app.codecov.io/gh/CLIUtils/CLI11/pull/1101/blob/include/CLI/TypeTools.hpp definitely would make sense based on being able to run this additional line:

CLI11/tests/HelpersTest.cpp

Line 1313 in bdd12bf

auto fspclass = CLI::detail::classify_object<std::filesystem::path>::value;

[phlptp]

I will see about getting the coverage back in a different PR

[phlptp]

I have wondered that before but never looking into it, I don't think these tests are doing what we think they are doing. This should have been a test failure.

[phlptp]

obviously not an issue to fix in this PR

[phlptp]

Is that action generating the commit(s) automatically? Is it something that could be run regularly on a CI job?

[jsoref]

The action only complains about spelling. Commits require a human.

There are some tools that automatically suggest corrections (I'm not particularly enamored by any of them).

I have a spreadsheet that I've used in the past to get Google to make suggestions which can generate commands that I use with another script to make uniform commits. Recently I've just written the commands out by hand since I haven't had enough corrections relative to unknown words to justify using the spreadsheet.

[phlptp]

This check seems to be catching more than was caught with the codespell run as part of pre-commit. Wondering if it is something we should be running regularly?

[jsoref]

That's my general experience -- I regularly find bugs in repositories that use codespell. It's easy enough to configure. If you're interested, I can make a PR to enable it after this is merged. There are a couple of tunables worth discussing. (The sample workflow here is using a prerelease version, so I'd switch it to the current shipping release...)

[phlptp]

@jsoref I will probably dig deeper in the spelling for another repo, but I am going to merge this one. Thank You!

[jsoref]

@phlptp fwiw, I've rebased my checks and converted them from my prerelease to the latest release, (there's one spelling error that appears to have snuck in between when I prepared this PR and when it was merged), if you're interested in playing with the code, it's available here: https://github.com/jsoref/CLI11/tree/refs/heads/spell-check-with-spelling.

Or, if you want to play with check-spelling, you can try dropping https://github.com/check-spelling/spell-check-this/blob/prerelease/.github/workflows/spelling.yml into the workflows directory of another repository and let check-spelling walk you through adapting check-spelling to a repository.