From 8f6f2804dbba71bc00c1227b545cb7180a7ace7a Mon Sep 17 00:00:00 2001 From: Red-GitHubBot <88117545+Red-GitHubBot@users.noreply.github.com> Date: Wed, 8 Sep 2021 21:51:58 +0200 Subject: [PATCH] [3.4] Document parameters in remaining chat_formatting functions (#5215) (#5275) (cherry picked from commit dbd25e92a1627a23e5492d5af5188ed28d0de8d3) Co-authored-by: Kreus Amredes <67752638+Kreusada@users.noreply.github.com> Co-authored-by: Kreus Amredes <67752638+Kreusada@users.noreply.github.com> --- redbot/core/utils/chat_formatting.py | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/redbot/core/utils/chat_formatting.py b/redbot/core/utils/chat_formatting.py index 195ab8cd0..3e8ef048d 100644 --- a/redbot/core/utils/chat_formatting.py +++ b/redbot/core/utils/chat_formatting.py @@ -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