Better round tripping for See also section

Potential Fix for #188
numpy · Aug 12, 2018 · 1ce18aa · 1ce18aa
1 parent 659e43f
commit 1ce18aa
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/numpydoc/docscrape.py b/numpydoc/docscrape.py
@@ -442,7 +442,7 @@ def _str_see_also(self, func_role):
             elif func_role:
                 link = ':%s:`%s`' % (func_role, func)
             else:
-                link = "`%s`_" % func
+                link = "%s" % func
             if desc or last_had_desc:
                 out += ['']
                 out += [link]

diff --git a/numpydoc/tests/test_docscrape.py b/numpydoc/tests/test_docscrape.py
@@ -150,6 +150,11 @@
 doc_yields = NumpyDocString(doc_yields_txt)
 
 
+def test_to_docstring():
+    # Simple test, this should just not raise
+    NumpyDocString(doc.to_docstring())
+
+
 def test_signature():
     assert doc['Signature'].startswith('numpy.multivariate_normal(')
     assert doc['Signature'].endswith('spam=None)')
@@ -402,9 +407,9 @@ def test_str():
 See Also
 --------
 
-`some`_, `other`_, `funcs`_
+some, other, funcs
 
-`otherfunc`_
+otherfunc
     relationship
 
 Notes