mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 11:18:54 -05:00
e79aa21b55
* get_end_user_statement * add get_end_user_statement * I hate docs * lets make Jack and Zeph happy as they want a version that raises. * Apply suggestions from code review Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com> * Update redbot/core/utils/__init__.py Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com> * rename to `get_end_user_data_statement` * aaaaaaaaaaaaaaa Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
76 lines
1.3 KiB
ReStructuredText
76 lines
1.3 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
|
|
|
|
.. 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
|
|
|
|
Reaction 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
|
|
|
|
Common Filters
|
|
==============
|
|
|
|
.. automodule:: redbot.core.utils.common_filters
|
|
:members:
|