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.

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

use functools.wrap for the TimeFuncton wrapper. #175

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

rrraaaccc
Copy link

Applying the functools.wrap decorator is good practice and remains name and docstring of the original functions.

@rrraaaccc
Copy link
Author

Maybe a short explanation of the problem is helpful.
With the current implementation of TimeFunction the Sphinx autoapi feature does not work properly, for all decorated functions. This is due to the renaming of the function by the decorator itself. The use of functools.wrap solve this well known problem and is best practice for python decorators.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant