Skip to content

Commit

Permalink
Merge 03f9f90 into 5198dda
Browse files Browse the repository at this point in the history
  • Loading branch information
gkanor committed Mar 7, 2023
2 parents 5198dda + 03f9f90 commit 9cf04e7
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
1 change: 1 addition & 0 deletions AUTHORS.rst
Expand Up @@ -31,6 +31,7 @@ Documentation Contributors
- Johanna Rührig `@TheRealVira <https://github.com/TheRealVira>`_
- Sam Snarr `@sss-ng <https://github.com/sss-ng>`_
- Moshe Dicker `@dickermoshe <https://github.com/dickermoshe>`_
- u/gkanor `@gkanor <https://github.com/gkanor>`_
- Add "Name <email (optional)> and github profile link" above this line.

Logo Creator
Expand Down
15 changes: 9 additions & 6 deletions praw/models/reddit/mixins/__init__.py
Expand Up @@ -206,15 +206,18 @@ def send_removal_message(
Reddit adds human-readable information about the object to the message.
:param type: One of ``"public"``, ``"private"``, or ``"private_exposed"``.
``"public"`` leaves a stickied comment on the post. ``"private"`` sends a
modmail message with hidden username. ``"private_exposed"`` sends a modmail
message without hidden username (default: ``"public"``).
:param type: One of ``"public"``, ``"public_as_subreddit"``, ``"private"``, or
``"private_exposed"``. ``"public"`` leaves a stickied comment on the post.
``"public_as_subreddit"`` leaves a stickied comment on the post with the
u/subreddit-ModTeam account. ``"private"`` sends a modmail message with
hidden username. ``"private_exposed"`` sends a modmail message without
hidden username (default: ``"public"``).
:param title: The short reason given in the message. Ignored if type is
``"public"``.
``"public"`` or ``"public_as_subreddit"``.
:param message: The body of the message.
:returns: The new :class:`.Comment` if ``type`` is ``"public"``.
:returns: The new :class:`.Comment` if ``type`` is ``"public"`` or
``"public_as_subreddit"``.
"""
# The API endpoint used to send removal messages is different for posts and
Expand Down

0 comments on commit 9cf04e7

Please sign in to comment.