List of missing arguments not displayed in D417 Missing argument description error
See original GitHub issueWhen I get D417 errors the list of missing argument is not displayed in the error message. It would be much more convenient to have the list of missing argument displayed in the error message.
Looking at the code this list get generated here but does not end up being displayed in the final error message.
example:
def f(a: str, b: str) -> None:
"""
Simple function
Arguments:
---------
a: some argument
"""
print(a+b)
yields
D417 Missing argument descriptions in the docstring
while I would like to get
D417 Missing argument descriptions in the docstring for argument b
Issue Analytics
- State:
- Created 2 years ago
- Comments:15 (7 by maintainers)
Top Results From Across the Web
Error Codes — pydocstyle 1.0.0 documentation
D103, Missing docstring in public function ... D417, Missing argument descriptions in the docstring ... Not all error codes are checked for by...
Read more >how to resolve "missing arguments not allowed in calls to 'list ...
The error is in line 547 of your code. There is an extra trailing comma within a call to list() . If you...
Read more >pydocstyle Documentation - Read the Docs
options select the "basic list" of error codes to check. If you wish ... D417. Missing argument descriptions in the docstring.
Read more >pydocstyle — Debian unstable
pydocstyle is a static analysis tool for checking compliance with ... D101: Docstring missing test.py:27 in public function `get_user`:
Read more >ruff - PyPI
[tool.ruff] # Add "Q" to the list of enabled codes. select = ["E", "F", ... D417, DocumentAllArguments, Missing argument descriptions in the ...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found

I transferred it
flake8-docstringsfor youI mean there is flake8’s standard which is
CODE ASCII_SPACE MESSAGEthat’s why pydocstyle’s (.message)CODE COLON SPACE MESSAGEdoes not work – that’s the whole point of the issue