Merge pull request #1148 from praw-dev/deprecate

Deprecate moderator_subreddits
praw-dev · Dec 2, 2019 · 8c700c6 · 8c700c6
2 parents 8170ced + 18d1769
commit 8c700c6
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 5 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -19,11 +19,16 @@ Unreleased
   :class:`.Redditor` constructor now also has ``fullname`` param.
 * Add :class:`.RemovalReason` and :class:`.SubredditRemovalReasons` to work
   with removal reasons
-* Attribute ``removal_reasons`` to :class:`.SubredditModeration` to interact 
+* Attribute ``removal_reasons`` to :class:`.SubredditModeration` to interact
   with new removal reason classes
-* Parameters ``mod_note`` and ``reason_id`` to 
-  :meth:`.ThingModerationMixin.remove` to optionally apply a removal reason
-  on removal
+* Parameters ``mod_note`` and ``reason_id`` to
+  :meth:`.ThingModerationMixin.remove` to optionally apply a removal reason on
+  removal
+
+**Deprecated**
+
+* :meth:`.moderator_subreddits` as :meth:`.Redditor.moderated` provides more
+  functionality.
 
 6.4.0 (2019/09/21)
 ------------------

diff --git a/praw/models/user.py b/praw/models/user.py
@@ -100,7 +100,11 @@ def me(self, use_cache=True):  # pylint: disable=invalid-name
         return self._me
 
     def moderator_subreddits(self, **generator_kwargs):
-        """Return a ListingGenerator of subreddits the user is a moderator of.
+        """(DEPRECATED) Return a ListingGenerator of subreddits the user moderates.
+
+        ..warning:: (Deprecated) This method will be removed in the next major
+                    version of PRAW. Please use :meth:`.Redditor.moderated`
+                    instead.
 
         Additional keyword arguments are passed in the initialization of
         :class:`.ListingGenerator`.