Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

pydocstyle errors should not appear in .pyi files #6224

Closed
DetachHead opened this issue Aug 1, 2023 · 0 comments · Fixed by #6239
Closed

pydocstyle errors should not appear in .pyi files #6224

DetachHead opened this issue Aug 1, 2023 · 0 comments · Fixed by #6239

Comments

@DetachHead
Copy link 

# asdf.pyi
def asdf(): ...
>ruff asdf.pyi
asdf.pyi:1:5: D103 Missing docstring in public function
Found 1 error.

when adding a docstring, it triggers PYI021:

def asdf():
    """asdf"""
>ruff asdf.pyi
asdf.pyi:2:5: PYI021 Docstrings should not be included in stubs
Found 1 error.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Don't require docstrings in .pyi files astral-sh/ruff
1 participant
@DetachHead