CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 03:08:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

Document parameters in remaining chat_formatting functions (#5215)

Browse Source
This commit is contained in:
Kreus Amredes 2021-09-01 01:51:59 +01:00 committed by GitHub
parent c57ef4828e
commit dbd25e92a1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
redbot/core/utils/chat_formatting.py
View File

@ -16,6 +16,11 @@ _ = Translator("UtilsChatFormatting", __file__)
def error(text: str) -> str: def error(text: str) -> str:
"""Get text prefixed with an error emoji. """Get text prefixed with an error emoji.
Parameters
----------
text : str
The text to be prefixed.
Returns Returns
------- -------
str str
@ -28,6 +33,11 @@ def error(text: str) -> str:
def warning(text: str) -> str: def warning(text: str) -> str:
"""Get text prefixed with a warning emoji. """Get text prefixed with a warning emoji.
Parameters
----------
text : str
The text to be prefixed.
Returns Returns
------- -------
str str
@ -40,6 +50,11 @@ def warning(text: str) -> str:
def info(text: str) -> str: def info(text: str) -> str:
"""Get text prefixed with an info emoji. """Get text prefixed with an info emoji.
Parameters
----------
text : str
The text to be prefixed.
Returns Returns
------- -------
str str
@ -52,6 +67,11 @@ def info(text: str) -> str:
def question(text: str) -> str: def question(text: str) -> str:
"""Get text prefixed with a question emoji. """Get text prefixed with a question emoji.
Parameters
----------
text : str
The text to be prefixed.
Returns Returns
------- -------
str str