Skip to content
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

Jump to bottom

Use functools.wraps to include docstrings in decorated functions #356

Closed
w-k-jones opened this issue Oct 25, 2023 · 1 comment · Fixed by #359
Closed

Use functools.wraps to include docstrings in decorated functions #356

w-k-jones opened this issue Oct 25, 2023 · 1 comment · Fixed by #359
Labels
enhancement Addition of new features, or improved functionality of existing features
Milestone
Version 1.5.2

Comments

@w-k-jones
Copy link
Member

A function wrapped with a decorator will show the decorator's docstring, not the function that we want to see. We can use functools.wraps to handle this (see: https://docs.python.org/3/library/functools.html)
@w-k-jones w-k-jones added the enhancement Addition of new features, or improved functionality of existing features label Oct 25, 2023
@w-k-jones w-k-jones mentioned this issue Oct 27, 2023
Merged
11 tasks
@freemansw1 freemansw1 linked a pull request Nov 13, 2023 that will close this issue
Wrap decorators to preserve docstrings and move to separate module #359
Merged
11 tasks
@freemansw1 freemansw1 added this to the Version 1.5.2 milestone Nov 13, 2023
@freemansw1
Copy link
Member

Closing as it was resolved with #359

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Addition of new features, or improved functionality of existing features
Projects
None yet
Milestone
Version 1.5.2
Development

Successfully merging a pull request may close this issue.

Wrap decorators to preserve docstrings and move to separate module w-k-jones/tobac
2 participants
@freemansw1 @w-k-jones