Skip to content

Commit

Permalink
Added limit documentation for reddit.user.moderator_subreddits() (#1145)
Browse files Browse the repository at this point in the history
* Documented moderator_subreddits's limit of 100
  • Loading branch information
kungming2 authored and bboe committed Dec 1, 2019
1 parent 54f8b3f commit 7424c91
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ to you, it likely is not to the person asking the question.
commenting on the issue. This act will hopefully minimize any duplicate
work.

0. Prior to creating a pull request run the `pre_push.sh` script. This script
0. Prior to creating a pull request run the `pre_push.py` script. This script
depends on the tools `black` `flake8`, `pylint`, and `pydocstyle`. They can
be installed via `pip install black flake8 pydocstyle pylint`.

Expand Down
12 changes: 12 additions & 0 deletions praw/models/user.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,18 @@ def moderator_subreddits(self, **generator_kwargs):
Additional keyword arguments are passed in the initialization of
:class:`.ListingGenerator`.
.. note:: This method will return a maximum of 100 moderated
subreddits, ordered by subscriber count. To retrieve more than
100 moderated subreddits, please see :meth:`.Redditor.moderated`.
Usage:
.. code-block:: python
for subreddit in reddit.user.moderator_subreddits():
print(subreddit.display_name)
"""
return ListingGenerator(
self._reddit, API_PATH["my_moderator"], **generator_kwargs
Expand Down

0 comments on commit 7424c91

Please sign in to comment.