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

DOC202 false positive when function doesn't return #12650

Closed
NeilGirdhar opened this issue Aug 2, 2024 · 1 comment · Fixed by #12651
Closed

DOC202 false positive when function doesn't return #12650

NeilGirdhar opened this issue Aug 2, 2024 · 1 comment · Fixed by #12651
Labels
bug Something isn't working docstring Related to docstring linting or formatting

Comments

@NeilGirdhar
Copy link 

class C:
    def f(self) -> int:
        """Calculate x.

        Returns:
            x
        """
        raise NotImplementedError

Raises DOC202
@charliermarsh charliermarsh added bug Something isn't working docstring Related to docstring linting or formatting labels Aug 2, 2024
@charliermarsh
Copy link
Member

Thanks! Makes sense.

@charliermarsh charliermarsh mentioned this issue Aug 3, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working docstring Related to docstring linting or formatting
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Ignore DOC errors for stub functions astral-sh/ruff
2 participants
@NeilGirdhar @charliermarsh