Skip to content

Commit

Permalink
Update SubredditModeration.update documentation
Browse files Browse the repository at this point in the history
(cherry picked from commit 4f9e9847effe1fead1c0a7b81ebdbc935624eb7a)
  • Loading branch information
timendum authored and LilSpazJoekp committed Jan 25, 2021
1 parent 1966112 commit c2c3e56
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions asyncpraw/models/reddit/subreddit.py
Expand Up @@ -2418,6 +2418,8 @@ def unread(self, **generator_kwargs):
async def update(self, **settings):
"""Update the subreddit's settings.
See https://www.reddit.com/dev/api#POST_api_site_admin for the full list.
:param all_original_content: Mandate all submissions to be original
content only.
:param allow_chat_post_creation: Allow users to create chat
Expand Down Expand Up @@ -2447,7 +2449,7 @@ async def update(self, **settings):
from modqueue/unmoderated.
:param free_form_reports: Allow users to specify custom reasons in the
report menu.
:param header_hover_text: The text seen when hovering over the snoo.
:param header-title: The text seen when hovering over the snoo.
:param hide_ads: Don't show ads within this subreddit. Only applies to
Premium-user only subreddits.
:param key_color: A 6-digit rgb hex color (e.g. ``"#AABBCC"``), used as
Expand Down Expand Up @@ -2479,14 +2481,13 @@ async def update(self, **settings):
:param submit_text: Text to show on submission page.
:param submit_text_label: Custom label for submit text post button
(None for default).
:param subreddit_type: One of ``archived``, ``employees_only``,
``gold_only``, ``gold_restricted``, ``private``, ``public``,
``restricted``.
:param suggested_comment_sort: All comment threads will use this
:param suggested_comment_sort: All comment threads will use this
sorting method by default. Leave None, or choose one of
``confidence``, ``controversial``, ``live``, ``new``, ``old``,
``qa``, ``random``, ``top``.
:param title: The title of the subreddit.
:param type: One of ``archived``, ``employees_only``, ``gold_only``,
``gold_restricted``, ``private``, ``public``, ``restricted``.
:param welcome_message_enabled: Enables the subreddit welcome message.
:param welcome_message_text: The text to be used as a welcome message.
A welcome message is sent to all new subscribers by a Reddit bot.
Expand Down

0 comments on commit c2c3e56

Please sign in to comment.