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

'cachedproperty' decorator replace original's method docstring #109

Closed
kdeldycke opened this issue Jan 13, 2017 · 4 comments
Closed

'cachedproperty' decorator replace original's method docstring #109

kdeldycke opened this issue Jan 13, 2017 · 4 comments

Comments

@kdeldycke
Copy link
Contributor

I'm using cachedproperty a lot as a decorator but the latter seems to replace the original method's docstring by its own.

See for instance that code: https://github.com/kdeldycke/maildir-deduplicate/blob/v2.0.1/maildir_deduplicate/mail.py#L59-L68 . It is rendered by Sphinx with the decorator's docstring instead of the one from the decorated method. See: https://maildir-deduplicate.readthedocs.io/en/stable/maildir_deduplicate.html#maildir_deduplicate.mail.Mail.message

@induane
Copy link
Contributor

induane commented Jan 13, 2017 via email

@induane
Copy link
Contributor

induane commented Jan 13, 2017

I added a pull request that should fix the issue:

#110

@mahmoud
Copy link
Owner

mahmoud commented Jan 14, 2017

My my my, thank you @kdeldycke for the report and @induane for the fix! I've merged and will release shortly. Thanks again, both of you!

@mahmoud mahmoud closed this as completed Jan 14, 2017
@kdeldycke
Copy link
Contributor Author

Wow, that was fast! Thanks @induane and @mahmoud ! :)

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

No branches or pull requests

3 participants