Skip to content

Commit 93b15ca

Browse files
committed
Don't add a new line in one-line Numpy docstrings
1 parent 54809b3 commit 93b15ca

File tree

4 files changed

+23
-1
lines changed

4 files changed

+23
-1
lines changed

pydocstringformatter/_formatting/formatters_numpydoc.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ def treat_sections(
100100
"""Ensure proper spacing between sections."""
101101
for section_lines in sections.values():
102102
last_line = section_lines[-1]
103-
if not (last_line == "" or last_line.isspace()):
103+
if not (last_line == "" or last_line.isspace()) and len(sections) > 1:
104104
section_lines.append("")
105105
return sections
106106

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
--style=numpydoc
2+
--no-closing-quotes
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
def func():
2+
"""
3+
A docstring"""
4+
5+
def func():
6+
"""
7+
A docstring
8+
"""
9+
10+
def func():
11+
"""A docstring."""
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
def func():
2+
"""A docstring."""
3+
4+
def func():
5+
"""A docstring.
6+
"""
7+
8+
def func():
9+
"""A docstring."""

0 commit comments

Comments
 (0)