Skip to content

DOC: Fix docstring for pandas.util._decorators.doc #52073

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 19, 2023
Merged

DOC: Fix docstring for pandas.util._decorators.doc #52073

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18c5783
Update _decorators.py
deepyaman Mar 19, 2023
37fd829
Update _decorators.py
deepyaman Mar 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions pandas/util/_decorators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,8 +339,8 @@ def wrapper(*args, **kwargs):

def doc(*docstrings: None | str | Callable, **params) -> Callable[[F], F]:
"""
A decorator take docstring templates, concatenate them and perform string
substitution on it.
A decorator to take docstring templates, concatenate them and perform string
substitution on them.

This decorator will add a variable "_docstring_components" to the wrapped
callable to keep track the original docstring template for potential usage.
Expand Down