codespell-project / codespell

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

The README creates confusion about the '--interactive' flag #3491

Closed LinuxOnTheDesktop closed 1 month ago

LinuxOnTheDesktop commented 1 month ago

   The README say, early on, that it recommends using the -w flag with the -i flag. So I tried that immediately. That led to errors and I started wondering whether flags most go in a particular position within the command. After a while I read more of the README and discovered that -i takes an argument of its own. Arguably, here we have a PEBCAK. But there is the following problem. So far as I can see, the README does not actually explain that argument or, more precisely, its different possible values.

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.