question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

List of missing arguments not displayed in D417 Missing argument description error

See original GitHub issue

When 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:open
  • Created 2 years ago
  • Comments:15 (7 by maintainers)

github_iconTop GitHub Comments

1reaction
sigmavirus24commented, Mar 11, 2022

I transferred it flake8-docstrings for you

0reactions
asottilecommented, Sep 23, 2022

I mean there is flake8’s standard which is CODE ASCII_SPACE MESSAGE that’s why pydocstyle’s (.message) CODE COLON SPACE MESSAGE does not work – that’s the whole point of the issue

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found