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

Warnings in docstring for constants #478

Open
HealthyPear opened this issue Jul 19, 2023 · 0 comments
Open

Warnings in docstring for constants #478

HealthyPear opened this issue Jul 19, 2023 · 0 comments

Comments

@HealthyPear
Copy link

I have a couple warnings that I don't understand, also because I am doing already what the validator says...

SOME_CONSTANT = 1
"""
summary line.

some explanation.
"""

I get

GL01: Docstring text (summary) should start in the line immediately after the opening quotes (not in the same line, or leaving a blank line in between)
  GL02: Closing quotes should be placed in the line after the last text in the docstring (do not close the quotes in the same line as the text, or leave a blank line between the last text and the quotes)

the same thing also in the case of a single summary line (for which I would argue that these 2 warnings should be disabled by default as per PEP257), doesn't matter if the quotes are on the same line or not.

I am using numpydoc v1.5.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant