Skip to content

Commit 56d621b

Browse files
committed
Remove $ from __text_signature__
Fix python C sigangure $ issues. Revert removal of star test.
1 parent 96216c0 commit 56d621b

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

numpydoc/numpydoc.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,7 @@ def mangle_signature(app, what, name, obj, options, sig, retann):
206206
sig = doc['Signature'] or getattr(obj, '__text_signature__', None)
207207
if sig:
208208
sig = re.sub("^[^(]*", "", sig)
209+
sig = re.sub("$", "", sig)
209210
return sig, ''
210211

211212

numpydoc/tests/test_docscrape.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -691,6 +691,17 @@ def test_parameters_without_extended_description():
691691
""")
692692

693693

694+
def test_escape_stars():
695+
signature = str(doc3).split('\n')[0]
696+
assert signature == r'my_signature(\*params, \*\*kwds)'
697+
698+
def my_func(a, b, **kwargs):
699+
pass
700+
701+
fdoc = FunctionDoc(func=my_func)
702+
assert fdoc['Signature'] == 'my_func(a, b, **kwargs)'
703+
704+
694705
doc4 = NumpyDocString(
695706
"""a.conj()
696707

0 commit comments

Comments
 (0)