Red-DiscordBot/docs/framework_utils.rst
Kreusada 1c7178a10b
Add automodule reference for the antispam module (#5641)
Co-authored-by: Jakub Kuczys <me@jacken.men>
Co-authored-by: Flame442 <34169552+Flame442@users.noreply.github.com>
2022-12-22 17:49:44 -05:00

89 lines
1.5 KiB
ReStructuredText

.. red's core utils documentation
=================
Utility Functions
=================
General Utility
===============
.. automodule:: redbot.core.utils
:members: deduplicate_iterables, bounded_gather, bounded_gather_iter, get_end_user_data_statement, get_end_user_data_statement_or_raise, can_user_send_messages_in, can_user_manage_channel, can_user_react_in
.. autoclass:: AsyncIter
:members:
:special-members: __await__
:exclude-members: enumerate, filter
.. automethod:: enumerate
:async-for:
.. automethod:: filter
:async-for:
Chat Formatting
===============
.. automodule:: redbot.core.utils.chat_formatting
:members:
Embed Helpers
=============
.. automodule:: redbot.core.utils.embed
:members:
:exclude-members: randomize_color
Menus
=====
.. automodule:: redbot.core.utils.menus
:members:
Event Predicates
================
MessagePredicate
****************
.. autoclass:: redbot.core.utils.predicates.MessagePredicate
:members:
ReactionPredicate
*****************
.. autoclass:: redbot.core.utils.predicates.ReactionPredicate
:members:
Mod Helpers
===========
.. automodule:: redbot.core.utils.mod
:members:
Tunnel
======
.. automodule:: redbot.core.utils.tunnel
:members: Tunnel
:exclude-members: files_from_attatch
Common Filters
==============
.. automodule:: redbot.core.utils.common_filters
:members:
Utility UI
==========
.. automodule:: redbot.core.utils.views
:members:
AntiSpam
========
.. automodule:: redbot.core.utils.antispam
:members: