Improve --dummy-variables-rgx
and --ignored-argument-names
documentation
#8013
Labels
Documentation 📗
Enhancement ✨
Improvement to a component
Needs specification 🔐
Accepted as a potential improvement, and needs to specify edge cases, message names, etc.
Question
Could the documentation be made more helpful for people trying to ignore dummy arguments?
Documentation for future user
Suppose that I'm looking to suppress
unused-argument
for all function arguments starting with "mock_".I might find the option
--dummy-variables-rgx
:But wait, it doesn't work. Even though arguments are variables.
I might then find the option
--ignored-argument-names
:The default value looks promising. But wait, why isn't it named
--dummy-arguments-rgx
? And why is the documentation so different? Is it because this is actually going to suppress a bunch of messages other thanunused-variable
, such asinvalid_name
? What does it actually do? Even regular maintainers are confused.Eventually I learn that it will (at least) suppress
unused-variable
,too-many-args
, and some docstring message(s).My suggestion is to
--dummy-variables-rgx
will not work for dummy arguments and point the user towards--ignored-argument-names
, and--ignored-argument-names
clear about what it actually does (what messages it might suppress).Additional context
No response
The text was updated successfully, but these errors were encountered: