mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 03:08:55 -05:00
Document parameters in remaining chat_formatting functions (#5215)
This commit is contained in:
parent
c57ef4828e
commit
dbd25e92a1
@ -16,6 +16,11 @@ _ = Translator("UtilsChatFormatting", __file__)
|
||||
def error(text: str) -> str:
|
||||
"""Get text prefixed with an error emoji.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
text : str
|
||||
The text to be prefixed.
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
@ -28,6 +33,11 @@ def error(text: str) -> str:
|
||||
def warning(text: str) -> str:
|
||||
"""Get text prefixed with a warning emoji.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
text : str
|
||||
The text to be prefixed.
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
@ -40,6 +50,11 @@ def warning(text: str) -> str:
|
||||
def info(text: str) -> str:
|
||||
"""Get text prefixed with an info emoji.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
text : str
|
||||
The text to be prefixed.
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
@ -52,6 +67,11 @@ def info(text: str) -> str:
|
||||
def question(text: str) -> str:
|
||||
"""Get text prefixed with a question emoji.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
text : str
|
||||
The text to be prefixed.
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user