Document methods in rrule module
#1025
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
autodoc will inspect the __doc__ attribute of the method. Since the decorator replaces the original method we use functools.wrap to copy __doc__.
ffe4
force-pushed
the
docs-rrule-inherited-members
branch
from
ed6fe8f
to
7a3f5c4
Compare
ffe4
changed the title
ffe4
commented
Apr 5, 2020
| from math import gcd | ||
| except ImportError: | ||
| from fractions import gcd | ||
| from functools import wraps |
There was a problem hiding this comment.
functools.wraps is new, the rest have been sorted by isort
ffe4
changed the title
rrule module
pganssle
approved these changes
Apr 24, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of changes
The current documentation on RTD does not display any of the already documented methods in the
rrulemodule.rruleandrrulesetfunctools.wrapson decorator to preserve__doc__attribute ofrulesetmethods.The imports were unintentionally reorganized with
isortby my editor, but I'd prefer keeping them that way.Pull Request Checklist