[doc] Remove hard-coded default in 'ignored-argument-names' descripti…

…on (#7239)
pylint-dev · Jul 30, 2022 · 4117389 · 4117389
1 parent 36a6723
commit 4117389
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 7 deletions.
diff --git a/doc/user_guide/configuration/all-options.rst b/doc/user_guide/configuration/all-options.rst
@@ -1523,7 +1523,7 @@ Standard Checkers
 
 --ignored-argument-names
 """"""""""""""""""""""""
-*Argument names that match this expression will be ignored. Default to name with leading underscore.*
+*Argument names that match this expression will be ignored.*
 
 **Default:**  ``re.compile('_.*|^ignored_|^unused_')``
 

diff --git a/examples/pylintrc b/examples/pylintrc
@@ -468,8 +468,7 @@ callbacks=cb_,
 # not be used).
 dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
 
-# Argument names that match this expression will be ignored. Default to name
-# with leading underscore.
+# Argument names that match this expression will be ignored.
 ignored-argument-names=_.*|^ignored_|^unused_
 
 # Tells whether we should check for unused import in __init__ files.

diff --git a/examples/pyproject.toml b/examples/pyproject.toml
@@ -509,8 +509,7 @@ callbacks = ["cb_", "_cb"]
 # be used).
 dummy-variables-rgx = "_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_"
 
-# Argument names that match this expression will be ignored. Default to name with
-# leading underscore.
+# Argument names that match this expression will be ignored.
 ignored-argument-names = "_.*|^ignored_|^unused_"
 
 # Tells whether we should check for unused import in __init__ files.

diff --git a/pylint/checkers/variables.py b/pylint/checkers/variables.py
@@ -1056,8 +1056,7 @@ class VariablesChecker(BaseChecker):
                 "default": IGNORED_ARGUMENT_NAMES,
                 "type": "regexp",
                 "metavar": "<regexp>",
-                "help": "Argument names that match this expression will be "
-                "ignored. Default to name with leading underscore.",
+                "help": "Argument names that match this expression will be ignored.",
             },
         ),
         (