Merge pull request #23048 from oscargus/rrulewrapperdocs

jklymak · web-flow · commit 875209ec918f · 2022-05-18T08:49:18.000+02:00
Add rrulewrapper to docs
diff --git a/doc/api/dates_api.rst b/doc/api/dates_api.rst
@@ -9,4 +9,5 @@
 .. automodule:: matplotlib.dates
    :members:
    :undoc-members:
+   :exclude-members: rrule
    :show-inheritance:
diff --git a/lib/matplotlib/dates.py b/lib/matplotlib/dates.py
@@ -142,8 +142,8 @@
 
 * `YearLocator`: Locate years that are multiples of base.
 
-* `RRuleLocator`: Locate using a ``matplotlib.dates.rrulewrapper``.
-  ``rrulewrapper`` is a simple wrapper around dateutil_'s `dateutil.rrule`
+* `RRuleLocator`: Locate using a `rrulewrapper`.
+  `rrulewrapper` is a simple wrapper around dateutil_'s `dateutil.rrule`
   which allow almost arbitrary date tick specifications.
   See :doc:`rrule example </gallery/ticks/date_demo_rrule>`.
 
@@ -195,7 +195,7 @@
            'rrule', 'MO', 'TU', 'WE', 'TH', 'FR', 'SA', 'SU',
            'YEARLY', 'MONTHLY', 'WEEKLY', 'DAILY',
            'HOURLY', 'MINUTELY', 'SECONDLY', 'MICROSECONDLY', 'relativedelta',
-           'DateConverter', 'ConciseDateConverter')
+           'DateConverter', 'ConciseDateConverter', 'rrulewrapper')
 
 
 _log = logging.getLogger(__name__)
@@ -981,16 +981,28 @@ def __call__(self, x, pos=None):
 
 class rrulewrapper:
     """
-    A simple wrapper around a ``dateutil.rrule`` allowing flexible
+    A simple wrapper around a `dateutil.rrule` allowing flexible
     date tick specifications.
     """
     def __init__(self, freq, tzinfo=None, **kwargs):
+        """
+        Parameters
+        ----------
+        freq : {YEARLY, MONTHLY, WEEKLY, DAILY, HOURLY, MINUTELY, SECONDLY}
+            Tick frequency. These constants are defined in `dateutil.rrule`,
+            but they are accessible from `matplotlib.dates` as well.
+        tzinfo : `datetime.tzinfo`, optional
+            Time zone information. The default is None.
+        **kwargs
+            Additional keyword arguments are passed to the `dateutil.rrule`.
+        """
         kwargs['freq'] = freq
         self._base_tzinfo = tzinfo
 
         self._update_rrule(**kwargs)
 
     def set(self, **kwargs):
+        """Set parameters for an existing wrapper."""
         self._construct.update(kwargs)
 
         self._update_rrule(**self._construct)
