Skip to content

Commit abecfdf

Browse files
committed
Use inspect.cleandoc, not textwrap.dedent, to clean docstrings.
The latter would fail if the first line is not indented, which occurs.
1 parent 167ede8 commit abecfdf

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

lib/matplotlib/cbook/deprecation.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import functools
2-
import textwrap
2+
import inspect
33
import warnings
44

55

@@ -215,7 +215,7 @@ def wrapper(*args, **kwargs):
215215
warnings.warn(message, category, stacklevel=2)
216216
return func(*args, **kwargs)
217217

218-
old_doc = textwrap.dedent(old_doc or '').strip('\n')
218+
old_doc = inspect.cleandoc(old_doc or '').strip('\n')
219219
message = message.strip()
220220
new_doc = ('.. deprecated:: {since}\n'
221221
' {message}\n'

0 commit comments

Comments
 (0)