Skip to content

Commit 1caee82

Browse files
committed
update param names be more descriptive
1 parent eb7d12a commit 1caee82

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

pandas/util/_decorators.py

+9-9
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ def wrapper(*args, **kwargs) -> Callable[..., Any]:
245245
return decorate
246246

247247

248-
def doc(*args: Union[str, Callable], **kwargs: str) -> Callable[[F], F]:
248+
def doc(*supplements: Union[str, Callable], **substitutes: str) -> Callable[[F], F]:
249249
"""
250250
A decorator take docstring templates, concatenate them and perform string
251251
substitution on it.
@@ -258,10 +258,10 @@ def doc(*args: Union[str, Callable], **kwargs: str) -> Callable[[F], F]:
258258
259259
Parameters
260260
----------
261-
*args : str or callable
261+
*supplements : str or callable
262262
The string / docstring / docstring template to be appended in order
263263
after default docstring under callable.
264-
**kwags : str
264+
**substitutes : str
265265
The string which would be used to format docstring template.
266266
"""
267267

@@ -271,18 +271,18 @@ def decorator(call: F) -> F:
271271
if call.__doc__:
272272
docstring_components.append(dedent(call.__doc__))
273273

274-
for appender in args:
275-
if hasattr(appender, "_docstring_components"):
274+
for supplement in supplements:
275+
if hasattr(supplement, "_docstring_components"):
276276
docstring_components.extend(
277-
appender._docstring_components # type: ignore
277+
supplement._docstring_components # type: ignore
278278
)
279-
elif isinstance(appender, str) or appender.__doc__:
280-
docstring_components.append(appender)
279+
elif isinstance(supplement, str) or supplement.__doc__:
280+
docstring_components.append(supplement)
281281

282282
# formatting templates and concatenating docstring
283283
call.__doc__ = "".join(
284284
[
285-
component.format(**kwargs)
285+
component.format(**substitutes)
286286
if isinstance(component, str)
287287
else dedent(component.__doc__ or "")
288288
for component in docstring_components

0 commit comments

Comments
 (0)