Update documentation on --ignore-underscore-args option

jsh9 · Feb 16, 2025 · 299a57c · 299a57c
1 parent b05a41a
commit 299a57c
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/docs/config_options.md b/docs/config_options.md
@@ -185,6 +185,9 @@ return annotation in the function signature are consistent.
 If True, underscore arguments (such as \_, \_\_, ...) in the function signature
 do not need to appear in the docstring.
 
+Note: "underscore arguments" are not the same as "arguments with leading
+underscores" (such as `_a`).
+
 ## 14. `--check-class-attributes` (shortform: `-cca`, default: `True`)
 
 If True, check the class attributes (defined under the class definition)

diff --git a/pydoclint/flake8_entry.py b/pydoclint/flake8_entry.py
@@ -156,7 +156,9 @@ def add_options(cls, parser: Any) -> None:  # noqa: D102
             parse_from_config=True,
             help=(
                 'If True, underscore arguments (such as _, __, ...) in the function'
-                ' signature do not need to appear in the docstring.'
+                ' signature do not need to appear in the docstring. Note: "underscore'
+                ' arguments" are not the same as "arguments with leading'
+                ' underscores" (such as `_a`).'
             ),
         )
         parser.add_option(

diff --git a/pydoclint/main.py b/pydoclint/main.py
@@ -195,7 +195,9 @@ def validateStyleValue(
     default=True,
     help=(
         'If True, underscore arguments (such as _, __, ...) in the function'
-        ' signature do not need to appear in the docstring.'
+        ' signature do not need to appear in the docstring. Note: "underscore'
+        ' arguments" are not the same as "arguments with leading'
+        ' underscores" (such as `_a`).'
     ),
 )
 @click.option(