Spelling by jsoref · Pull Request #1101 · CLIUtils/CLI11

jsoref · 2024-12-06T06:35:38Z

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

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

codecov · 2024-12-06T06:38:56Z

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 · 2024-12-06T06:37:07Z

 - `-abcf filename` (flags and option can be combined)
 - `--long` (long flag)
- `--long_flag=true` (long flag with equals to override default value)
+- `--long_flag=true` (long flag with equals -- to override default value)


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 · 2024-12-06T06:38:03Z

 #   flags to the gcovr command
 #
-# 2020-05-04, Mihchael Davis
+# 2020-05-04, Michael Davis


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.

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

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

jsoref · 2024-12-06T06:38:40Z

 };

-// Warning is suppressed due to "bug" in gcc<5.0 and gcc 7.0 with c++17 enabled that generates a Wnarrowing warning
+// Warning is suppressed due to "bug" in gcc<5.0 and gcc 7.0 with c++17 enabled that generates a -Wnarrowing warning


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

jsoref · 2024-12-06T06:39:12Z

    CHECK(CLI::detail::object_category::wstring_assignable == wsclass);

-#if defined CLI11_HAS_FILEYSTEM && CLI11_HAS_FILESYSTEM > 0 && defined(_MSC_VER)
+#if defined CLI11_HAS_FILESYSTEM && CLI11_HAS_FILESYSTEM > 0 && defined(_MSC_VER)


Notably, this appears to be a broken guard

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

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;

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

phlptp · 2024-12-10T15:50:16Z

 set_property(
  TEST shapes_all PROPERTY PASS_REGULAR_EXPRESSION "circle2" "circle4"
-                           "rectangle2 with edges [2.1,2.1]" "triangel1 with sides [4.5]")
+                           "rectangle2 with edges [2.1,2.1]" "triangle1 with sides [4.5]")


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.

obviously not an issue to fix in this PR

phlptp · 2024-12-11T04:36:14Z

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

jsoref · 2024-12-11T06:25:00Z

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 · 2024-12-12T12:28:44Z

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 · 2024-12-12T14:37:20Z

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 · 2024-12-22T22:03:08Z

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

jsoref · 2024-12-23T12:25:02Z

@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.

jsoref and others added 23 commits November 27, 2024 01:22

link: short note to contributors

c428b60

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: a

c6c7330

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: anymore

8eb816e

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: case-insensitive

4e4bdaa

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: case-sensitive

10b1e83

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: command

1c1a497

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: equals -- to

2220015

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: error, error

f015a3a

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: escapable

e909b80

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: escape

ea32ad3

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: filesystem

acdb0e2

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: infinity

4868036

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: legitimately

fcf338f

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: michael

786db8a

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: multiline

aa4ab46

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: narrowing

963e452

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: nonexistent

991f952

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: ostream

5fcbe6e

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: placed

5ad8442

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: recursive

188fac5

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: transparent

d71f11f

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: triangle

817f83c

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

style: pre-commit.ci fixes

bdd12bf

jsoref commented Dec 6, 2024

View reviewed changes

phlptp reviewed Dec 10, 2024

View reviewed changes

phlptp merged commit ef50bb3 into CLIUtils:main Dec 22, 2024

jsoref deleted the spelling branch December 22, 2024 22:09

BrewTestBot mentioned this pull request Feb 27, 2025

cli11 2.5.0 Homebrew/homebrew-core#209127

Merged

Conversation

jsoref commented Dec 6, 2024

Uh oh!

codecov Bot commented Dec 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

phlptp commented Dec 11, 2024

Uh oh!

jsoref commented Dec 11, 2024

Uh oh!

phlptp commented Dec 12, 2024

Uh oh!

jsoref commented Dec 12, 2024

Uh oh!

phlptp commented Dec 22, 2024

Uh oh!

jsoref commented Dec 23, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov Bot commented Dec 6, 2024 •

edited

Loading