Skip to content

Commit 87fa3a1

Browse files
committed
Always surround docstrings with newlines
1 parent a0d4adb commit 87fa3a1

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

proplot/internals/docstring.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@
99

1010

1111
def add_snippets(func):
12-
"""Decorator that dedents docstrings with `inspect.getdoc` and adds
12+
"""
13+
Decorator that dedents docstrings with `inspect.getdoc` and adds
1314
un-indented snippets from the global `snippets` dictionary. This function
1415
uses ``%(name)s`` substitution rather than `str.format` substitution so
15-
that the `snippets` keys can be invalid variable names."""
16+
that the `snippets` keys can be invalid variable names.
17+
"""
1618
func.__doc__ = inspect.getdoc(func)
1719
if func.__doc__:
1820
func.__doc__ %= {key: value.strip() for key, value in snippets.items()}

0 commit comments

Comments
 (0)