Skip to content

Commit

Permalink
pull to main branch (#20)
Browse files Browse the repository at this point in the history
* [Trivia] Correct Stephen to Steven (Cog-Creators#6434)

Co-authored-by: Artemis6969 <[email protected]>

* Generate default LL server config and attach it to GH release (Cog-Creators#6430)

* [Audio] Update Lavalink.jar and yt source build numbers (Cog-Creators#6435)

Co-authored-by: Jakub Kuczys <[email protected]>

* [Audio] Fix trying to send notify message with no channel object (Cog-Creators#6429)

* Bump dependencies (Cog-Creators#6436)

* Red 3.5.13 - Changelog (Cog-Creators#6437)

* Automated Crowdin downstream (Cog-Creators#6439)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Version bump to 3.5.13 (Cog-Creators#6438)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Fix publish release workflow

* Add missing perm to Publish Release workflow

* Change Red 3.5.13 release date

* Version bump to 3.5.14.dev1

* [Trivia] Correct typos in World Cup trivia list for Golden Glove questions (Cog-Creators#6441)

* Split out non-Python assets in Publish Release workflow (Cog-Creators#6440)

* Add `header`, `hyperlink` and `subtext` utilities (Cog-Creators#6102) (#19)

Co-authored-by: Kreusada <[email protected]>
Co-authored-by: Kowlin <[email protected]>

---------

Co-authored-by: Guyonsteroids <[email protected]>
Co-authored-by: Artemis6969 <[email protected]>
Co-authored-by: Jakub Kuczys <[email protected]>
Co-authored-by: aikaterna <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Mellow <[email protected]>
Co-authored-by: Kreusada <[email protected]>
Co-authored-by: Kowlin <[email protected]>
  • Loading branch information
9 people authored Sep 1, 2024
1 parent 358ab12 commit 1fa02b2
Showing 1 changed file with 67 additions and 1 deletion.
68 changes: 67 additions & 1 deletion redbot/core/utils/chat_formatting.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import math
import textwrap
from io import BytesIO
from typing import Iterator, List, Optional, Sequence, SupportsInt, Union
from typing import Iterator, List, Literal, Optional, Sequence, SupportsInt, Union

import discord
from babel.lists import format_list as babel_list
Expand All @@ -21,11 +21,14 @@
"question",
"bold",
"box",
"header",
"hyperlink",
"inline",
"italics",
"spoiler",
"pagify",
"strikethrough",
"subtext",
"underline",
"quote",
"escape",
Expand All @@ -39,6 +42,69 @@
_ = Translator("UtilsChatFormatting", __file__)


def hyperlink(text: str, url: str) -> str:
"""Create hyperlink markdown with text and a URL.
Parameters
----------
text : str
The text which will contain the link.
url : str
The URL used for the hyperlink.
Returns
-------
str
The new message.
"""
return f"[{text}]({url})"


def header(text: str, size: Literal["small", "medium", "large"]) -> str:
"""Formats a header.
Parameters
----------
text : str
The text for the header.
url : Literal['small', 'medium', 'large']
The size of the header ('small', 'medium' or 'large')
Returns
-------
str
The new message.
"""
if size == "small":
multiplier = 3
elif size == "medium":
multiplier = 2
elif size == "large":
multiplier = 1
else:
raise ValueError(f"Invalid size '{size}'")
return "#" * multiplier + " " + text


def subtext(text: str) -> str:
"""Formats subtext from the given text.
Parameters
----------
text : str
The text to format as subtext.
Returns
-------
str
The new message.
"""
return "-# " + text


def error(text: str) -> str:
"""Get text prefixed with an error emoji.
Expand Down

0 comments on commit 1fa02b2

Please sign in to comment.