codespell-project / codespell

check code for common misspellings
GNU General Public License v2.0
1.86k stars 471 forks source link

README: '--quiet-level' is mentioned but not explained #3492

Open LinuxOnTheDesktop opened 1 month ago

LinuxOnTheDesktop commented 1 month ago

The README has:

codespell --quiet-level 3 --count --skip "*.po,*.ts,./src/3rdParty,./src/Test"

One wonders what this quiet-level is and what its values do.

One wonders also whether a particular setting for it will prevent the following unfortunateness.

$ codespell /~/scripts -i 3 -w
                "Package Control: instal",
    instal ==> install (Y/n) 

What is unfortunate here is that I do not know while file is at issue.

DimitriPapadopoulos commented 1 month ago

From the README:

Below are some simple usage examples to demonstrate how the tool works. For exhaustive usage information, please check the output of codespell -h.

LinuxOnTheDesktop commented 1 month ago

That is a good point. Perhaps though I should open another issue about how codespell fails to identify the file that it faults - unless one counts the -A, -B and -C options.

DimitriPapadopoulos commented 1 month ago

I believe this is on intent, the file name is considered irrelevant when using -i:

$ codespell path
path/to/file:1: syncin ==> syncing, sync in
$ 
$ codespell -w path
path/to/file:1: syncin ==> syncing, sync in
$ 
$ codespell -w -i 3 path
syncin
 Choose an option (blank for none):  0) syncing 1) sync in:  
$