Skip to content

Commit

Permalink
Update docs for new appeals state for modmail conversation.
Browse files Browse the repository at this point in the history
Changed wording (requested change)

update authors.rst
  • Loading branch information
mandjevant committed Jul 22, 2020
1 parent a8f7915 commit 0fb622e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
2 changes: 2 additions & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Documentation Contributors
- Eric Woolard `@ericwoolard <https://github.com/ericwoolard>`_
- Marc `@PerhapsSomeone <https://github.com/PerhapsSomeone>`_
- Richard Hoekstra `@RichardHoekstra <https://github.com/RichardHoekstra>`_
- Pim Tholhuijsen `@mandjevant <https://github.com/mandjevant>`_

<!-- - Add "Name <email (optional)> and github profile link" above this line. -->


Expand Down
14 changes: 7 additions & 7 deletions asyncpraw/models/reddit/subreddit.py
Original file line number Diff line number Diff line change
Expand Up @@ -2359,8 +2359,8 @@ def modmail_conversations(
:param sort: Can be one of: mod, recent, unread, user
(default: recent).
:param state: Can be one of: all, archived, highlighted, inprogress,
mod, new, notifications, (default: all). "all" does not include
internal or archived conversations.
mod, new, notifications, or appeals, (default: all). "all" does not
include internal, archived, or appeals conversations.
Keyword arguments are passed to :func:`.stream_generator`.
Expand Down Expand Up @@ -2934,8 +2934,8 @@ async def bulk_read(self, other_subreddits=None, state=None):
:param other_subreddits: A list of :class:`.Subreddit` instances for
which to mark conversations (default: None).
:param state: Can be one of: all, archived, highlighted, inprogress,
mod, new, notifications, (default: all). "all" does not include
internal or archived conversations.
mod, new, notifications, or appeals, (default: all). "all" does not
include internal, archived, or appeals conversations.
:returns: A list of lazy :class:`.ModmailConversation` instances that were
marked read.
Expand Down Expand Up @@ -2973,8 +2973,8 @@ async def conversations(
:param sort: Can be one of: mod, recent, unread, user
(default: recent).
:param state: Can be one of: all, archived, highlighted, inprogress,
mod, new, notifications, (default: all). "all" does not include
internal or archived conversations.
mod, new, notifications, or appeals, (default: all). "all" does not
include internal, archived, or appeals conversations.
For example:
Expand Down Expand Up @@ -3065,7 +3065,7 @@ async def unread_count(self):
"""Return unread conversation count by conversation state.
At time of writing, possible states are: archived, highlighted,
inprogress, mod, new, notifications.
inprogress, mod, new, notifications, or appeals.
:returns: A dict mapping conversation states to unread counts.
Expand Down

0 comments on commit 0fb622e

Please sign in to comment.