Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

Google convention doesn't raise D417 when section Returns is present #490

Closed
freddyaboulton opened this issue Jul 1, 2020 · 1 comment
Closed

Comments

@freddyaboulton
Copy link

Pydocstyle won't raise D417 when a section called Returns is present in the docstring.

With pydocstyle 5.0.1, the following example won't raise a D417 (pydocstyle example.py --convention google):

"""Example."""

def foo(a, b, c):
    """Docstring.

    Arguments:
        a (int): First number
        b (int): Second number
        d (int): Third number

    Returns:
       int: sum
    """
    return a + b + c

When I change Returns to Returns, D417 is raised. Also, when no Returns or Return section is present, D417 is raised.

@samj1912
Copy link
Member

samj1912 commented Jul 2, 2020

Copy of #459

@samj1912 samj1912 closed this as completed Jul 2, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants