fix: deprecate underscore in favor of underline (#10054)

* fix: deprecate `underscore` in favor of `underline`

* refactor: use `underline` in `underscore`

Co-authored-by: Almeida <github@almeidx.dev>

---------

Co-authored-by: Almeida <github@almeidx.dev>
This commit is contained in:
Danial Raza
2023-12-17 21:44:54 +01:00
committed by GitHub
parent 1acc9abae2
commit 461948c07d
2 changed files with 14 additions and 3 deletions

View File

@@ -61,8 +61,19 @@ export function bold<Content extends string>(content: Content): `**${Content}**`
*
* @typeParam Content - This is inferred by the supplied content
* @param content - The content to wrap
* @deprecated Use {@link underline} instead.
*/
export function underscore<Content extends string>(content: Content): `__${Content}__` {
return underline(content);
}
/**
* Formats the content into underlined text.
*
* @typeParam Content - This is inferred by the supplied content
* @param content - The content to wrap
*/
export function underline<Content extends string>(content: Content): `__${Content}__` {
return `__${content}__`;
}