Skip to content

docs: fix missing colon, attempt to fix the code-block in channel.purge #759

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 24, 2022
Merged

docs: fix missing colon, attempt to fix the code-block in channel.purge #759

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0fd4d57
Update channel.py
EepyElvyra Apr 24, 2022
0a25ca7
Update channel.py
EepyElvyra Apr 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion interactions/api/models/channel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ async def modify(
:param topic?: The topic of that channel, defaults to the current value of the channel
:type topic: Optional[str]
:param bitrate?: (voice channel only) The bitrate (in bits) of the voice channel, defaults to the current value of the channel
:type bitrate Optional[int]
:type bitrate: Optional[int]
:param user_limit?: (voice channel only) Maximum amount of users in the channel, defaults to the current value of the channel
:type user_limit: Optional[int]
:param rate_limit_per_use?: Amount of seconds a user has to wait before sending another message (0-21600), defaults to the current value of the channel
Expand Down Expand Up @@ -725,9 +725,11 @@ async def purge(
.. warning:: Calling this method can lead to rate-limits when purging higher amounts of messages.

.. code-block:: python

def check_pinned(message):
return not message.pinned # This returns `True` only if the message is the message is not pinned
await channel.purge(100, check=check_pinned) # This will delete the newest 100 messages that are not pinned in that channel

:param amount: The amount of messages to delete
:type amount: int
:param check?: The function used to check if a message should be deleted. The message is only deleted if the check returns `True`
Expand Down