diff options
| author | Paul Ganssle <paul@ganssle.io> | 2020-04-24 09:52:08 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-04-24 09:52:08 -0400 |
| commit | a02e8c036fb3718b1d8f641ec2ed637d4c765bc5 (patch) | |
| tree | d6763689370f05a7fd9510274d512de44e1990b2 | |
| parent | c175137e318aba93251f34a0c519c825433a7cba (diff) | |
| parent | 7a3f5c47d8037658edebeeadace13788562a815d (diff) | |
| download | dateutil-git-a02e8c036fb3718b1d8f641ec2ed637d4c765bc5.tar.gz | |
Merge pull request #1025 from ffe4/docs-rrule-inherited-members
Document methods in `rrule` module
| -rw-r--r-- | changelog.d/1025.doc.rst | 1 | ||||
| -rw-r--r-- | dateutil/rrule.py | 22 | ||||
| -rw-r--r-- | docs/rrule.rst | 6 |
3 files changed, 19 insertions, 10 deletions
diff --git a/changelog.d/1025.doc.rst b/changelog.d/1025.doc.rst new file mode 100644 index 0000000..5c6dfc9 --- /dev/null +++ b/changelog.d/1025.doc.rst @@ -0,0 +1 @@ +Fixed methods in the ``rrule`` module not being displayed in the docs. (gh pr #1025)
\ No newline at end of file diff --git a/dateutil/rrule.py b/dateutil/rrule.py index 6bf0ea9..b320339 100644 --- a/dateutil/rrule.py +++ b/dateutil/rrule.py @@ -5,25 +5,26 @@ the recurrence rules documented in the `iCalendar RFC <https://tools.ietf.org/html/rfc5545>`_, including support for caching of results. """ -import itertools -import datetime import calendar +import datetime +import heapq +import itertools import re import sys - -try: - from math import gcd -except ImportError: - from fractions import gcd +from functools import wraps +# For warning about deprecation of until and count +from warnings import warn from six import advance_iterator, integer_types + from six.moves import _thread, range -import heapq from ._common import weekday as weekdaybase -# For warning about deprecation of until and count -from warnings import warn +try: + from math import gcd +except ImportError: + from fractions import gcd __all__ = ["rrule", "rruleset", "rrulestr", "YEARLY", "MONTHLY", "WEEKLY", "DAILY", @@ -81,6 +82,7 @@ def _invalidates_cache(f): Decorator for rruleset methods which may invalidate the cached length. """ + @wraps(f) def inner_func(self, *args, **kwargs): rv = f(self, *args, **kwargs) self._invalidate_cache() diff --git a/docs/rrule.rst b/docs/rrule.rst index 66b3cfc..3ba2768 100644 --- a/docs/rrule.rst +++ b/docs/rrule.rst @@ -9,7 +9,13 @@ Classes ------- .. autoclass:: rrule + :members: + :undoc-members: + :inherited-members: .. autoclass:: rruleset + :members: + :undoc-members: + :inherited-members: Functions --------- |