From d9b0bac1c7b177c4c0343853a77446fe5c0f7940 Mon Sep 17 00:00:00 2001 From: Bryce Boe Date: Sun, 1 Dec 2019 19:19:17 -0800 Subject: [PATCH] Deprecate moderator_subreddits --- CHANGES.rst | 13 +++++++++---- praw/models/user.py | 4 +++- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 9421b63560..6739a004c1 100644 --- 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 index 4077f48f2c..479dbc74e2 100644 --- a/praw/models/user.py +++ b/praw/models/user.py @@ -100,7 +100,9 @@ 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. + """(DEPRECATD) Return a ListingGenerator of subreddits the user is a moderator of. + + ..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`.