Skip to content

Commit

Permalink
GL01 catches valid docstring example
Browse files Browse the repository at this point in the history
```
def my_func():
   """Docstring on first line.

   Should be totally fine.
   """
   ...
```
  • Loading branch information
stefanv committed Jul 17, 2024
1 parent 7716617 commit 79726c7
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions numpydoc/validate.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,8 @@
# modify/remove
# start-err-msg
ERROR_MSGS = {
"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)",
"GL01": "Docstring text (summary) should start right after, or on the "
"line following the opening quotes",
"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 "
Expand Down Expand Up @@ -343,6 +342,7 @@ def start_blank_lines(self):
for i, row in enumerate(self.raw_doc.split("\n")):
if row.strip():
break

return i

@property
Expand Down Expand Up @@ -645,7 +645,7 @@ def validate(obj_name, validator_cls=None, **validator_kwargs):
"examples_errors": "",
}

if doc.start_blank_lines != 1 and "\n" in doc.raw_doc:
if doc.start_blank_lines not in (0, 1) and "\n" in doc.raw_doc:
errs.append(error("GL01"))
if doc.end_blank_lines != 1 and "\n" in doc.raw_doc:
errs.append(error("GL02"))
Expand Down

0 comments on commit 79726c7

Please sign in to comment.