summaryrefslogtreecommitdiff
path: root/numpydoc
diff options
context:
space:
mode:
authorMatthias Bussonnier <bussonniermatthias@gmail.com>2021-12-27 19:40:34 +0100
committerGitHub <noreply@github.com>2021-12-27 19:40:34 +0100
commit4ae1e00e72e522c126403c1814f0b99dc5978622 (patch)
tree17e014a63ab24481b1ae267b94a17dccfd731e7d /numpydoc
parent31aa19a22a440ccc3aa69e657aea782968a5c23c (diff)
downloadnumpydoc-4ae1e00e72e522c126403c1814f0b99dc5978622.tar.gz
Escape newline in docstring. (#345)
Otherwise `'.` is seen as the second parameter.
Diffstat (limited to 'numpydoc')
-rw-r--r--numpydoc/docscrape.py2
1 files changed, 1 insertions, 1 deletions
diff --git a/numpydoc/docscrape.py b/numpydoc/docscrape.py
index 9e306ae..0127675 100644
--- a/numpydoc/docscrape.py
+++ b/numpydoc/docscrape.py
@@ -30,7 +30,7 @@ class Reader:
Parameters
----------
data : str
- String with lines separated by '\n'.
+ String with lines separated by '\\n'.
"""
if isinstance(data, list):