[3.2.0 Docs] Some clarifications (#3292)

* docs

*  changelog

* Fix python for choco

* k

* little more
This commit is contained in:
Michael H
2020-01-09 10:16:10 -05:00
committed by Kowlin
parent 26677004f1
commit 9698baf6e7
6 changed files with 30 additions and 31 deletions

View File

@@ -63,6 +63,8 @@ def question(text: str) -> str:
def bold(text: str) -> str:
"""Get the given text in bold.
Note: This escapes text prior to bolding.
Parameters
----------
text : str
@@ -121,6 +123,8 @@ def inline(text: str) -> str:
def italics(text: str) -> str:
"""Get the given text in italics.
Note: This escapes text prior to italicising
Parameters
----------
text : str
@@ -277,6 +281,8 @@ def pagify(
def strikethrough(text: str) -> str:
"""Get the given text with a strikethrough.
Note: This escapes text prior to applying a strikethrough
Parameters
----------
text : str
@@ -295,6 +301,8 @@ def strikethrough(text: str) -> str:
def underline(text: str) -> str:
"""Get the given text with an underline.
Note: This escapes text prior to underlining
Parameters
----------
text : str
@@ -332,7 +340,7 @@ def escape(text: str, *, mass_mentions: bool = False, formatting: bool = False)
text = text.replace("@everyone", "@\u200beveryone")
text = text.replace("@here", "@\u200bhere")
if formatting:
text = text.replace("`", "\\`").replace("*", "\\*").replace("_", "\\_").replace("~", "\\~")
text = discord.utils.escape_markdown(text)
return text