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.

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

Numpy convention breaks when a parameter is "error". #388

Closed
mrshannon opened this issue Jul 30, 2019 · 1 comment
Closed

Numpy convention breaks when a parameter is "error". #388

mrshannon opened this issue Jul 30, 2019 · 1 comment
Assignees

Comments

@mrshannon
Copy link

@mrshannon mrshannon commented Jul 30, 2019

When a parameter is labeled error, pydocstyle checking breaks for the remainder of the docstring.

Example

def do_stuff(error):
    """Do stuff with error.

    Parameters
    ----------
    error
        An error.

    """

pydocstyle output

pydocstyle_numpy.py:2 in public function `do_stuff`:
        D410: Missing blank line after section ('Parameters')
pydocstyle_numpy.py:2 in public function `do_stuff`:
        D414: Section has no content ('Parameters')
pydocstyle_numpy.py:2 in public function `do_stuff`:
        D405: Section name should be properly capitalized ('Error', not 'error')
pydocstyle_numpy.py:2 in public function `do_stuff`:
        D411: Missing blank line before section ('Error')
pydocstyle_numpy.py:2 in public function `do_stuff`:
        D407: Missing dashed underline after section ('Error')
@shacharoo

This comment has been minimized.

Copy link
Member

@shacharoo shacharoo commented Oct 23, 2019

Thanks for reporting @mrshannon ! I did some investigation and the problem is that "error" is a name of a google section.
I'll try to take a swing of it now :)

@shacharoo shacharoo self-assigned this Oct 23, 2019
@shacharoo shacharoo closed this Oct 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.