Skip to content

Commit 8cb1d3f

Browse files
srinivasreddyPingviinituutti
authored andcommitted
Fix doc string of make_signature() function (pandas-dev#23768)
1 parent 59647e5 commit 8cb1d3f

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

pandas/api/extensions/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Public API for extending panadas objects."""
1+
"""Public API for extending pandas objects."""
22
from pandas.core.accessor import (register_dataframe_accessor, # noqa
33
register_index_accessor,
44
register_series_accessor)

pandas/util/_decorators.py

+7-6
Original file line numberDiff line numberDiff line change
@@ -314,14 +314,15 @@ def indent(text, indents=1):
314314

315315
def make_signature(func):
316316
"""
317-
Returns a string repr of the arg list of a func call, with any defaults.
317+
Returns a tuple containing the paramenter list with defaults
318+
and parameter list.
318319
319320
Examples
320321
--------
321-
>>> def f(a,b,c=2) :
322-
>>> return a*b*c
323-
>>> print(_make_signature(f))
324-
a,b,c=2
322+
>>> def f(a, b, c=2):
323+
>>> return a * b * c
324+
>>> print(make_signature(f))
325+
(['a', 'b', 'c=2'], ['a', 'b', 'c'])
325326
"""
326327

327328
spec = signature(func)
@@ -332,7 +333,7 @@ def make_signature(func):
332333
n_wo_defaults = len(spec.args) - len(spec.defaults)
333334
defaults = ('',) * n_wo_defaults + tuple(spec.defaults)
334335
args = []
335-
for i, (var, default) in enumerate(zip(spec.args, defaults)):
336+
for var, default in zip(spec.args, defaults):
336337
args.append(var if default == '' else var + '=' + repr(default))
337338
if spec.varargs:
338339
args.append('*' + spec.varargs)

0 commit comments

Comments
 (0)