aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar MarkKoz <[email protected]>2020-05-06 14:30:37 -0700
committerGravatar MarkKoz <[email protected]>2020-06-13 11:21:06 -0700
commit0eca42cee34672fd59b82d0b36a70627a13d6354 (patch)
tree5d089261645e3016a6426b41f9d9126907608854
parentCode block: fix formatting of the additional message (diff)
Code block: use same lang specifier as the user for the py example
Keeping examples consistent will hopefully make things clearer to the user.
-rw-r--r--bot/cogs/codeblock/instructions.py10
1 files changed, 5 insertions, 5 deletions
diff --git a/bot/cogs/codeblock/instructions.py b/bot/cogs/codeblock/instructions.py
index dec5af874..9de418765 100644
--- a/bot/cogs/codeblock/instructions.py
+++ b/bot/cogs/codeblock/instructions.py
@@ -6,7 +6,7 @@ from . import parsing
log = logging.getLogger(__name__)
PY_LANG_CODES = ("python", "py")
-EXAMPLE_PY = f"python\nprint('Hello, world!')" # Make sure to escape any Markdown symbols here.
+EXAMPLE_PY = "{lang}\nprint('Hello, world!')" # Make sure to escape any Markdown symbols here.
EXAMPLE_CODE_BLOCKS = (
"\\`\\`\\`{content}\n\\`\\`\\`\n\n"
"**This will result in the following:**\n"
@@ -41,7 +41,7 @@ def get_bad_ticks_message(code_block: parsing.CodeBlock) -> Optional[str]:
else:
# Determine the example code to put in the code block based on the language specifier.
if code_block.language.lower() in PY_LANG_CODES:
- content = EXAMPLE_PY
+ content = EXAMPLE_PY.format(lang=code_block.language)
elif code_block.language:
# It's not feasible to determine what would be a valid example for other languages.
content = f"{code_block.language}\n..."
@@ -57,7 +57,7 @@ def get_bad_ticks_message(code_block: parsing.CodeBlock) -> Optional[str]:
def get_no_ticks_message(content: str) -> Optional[str]:
"""If `content` is Python/REPL code, return instructions on using code blocks."""
if parsing.is_repl_code(content) or parsing.is_python_code(content):
- example_blocks = EXAMPLE_CODE_BLOCKS.format(content=EXAMPLE_PY)
+ example_blocks = EXAMPLE_CODE_BLOCKS.format(content=EXAMPLE_PY.format(lang="python"))
return (
"It looks like you're trying to paste code into this channel.\n\n"
"Discord has support for Markdown, which allows you to post code with full "
@@ -89,7 +89,7 @@ def get_bad_lang_message(content: str) -> Optional[str]:
f"There must not be any spaces after `{lang}`."
)
- example_blocks = EXAMPLE_CODE_BLOCKS.format(content=EXAMPLE_PY)
+ example_blocks = EXAMPLE_CODE_BLOCKS.format(content=EXAMPLE_PY.format(lang=lang))
lines.append(f"\n**Here is an example of how it should look:**\n{example_blocks}")
return "\n".join(lines)
@@ -102,7 +102,7 @@ def get_no_lang_message(content: str) -> Optional[str]:
If `content` is not valid Python or Python REPL code, return None.
"""
if parsing.is_repl_code(content) or parsing.is_python_code(content):
- example_blocks = EXAMPLE_CODE_BLOCKS.format(content=EXAMPLE_PY)
+ example_blocks = EXAMPLE_CODE_BLOCKS.format(content=EXAMPLE_PY.format(lang="python"))
# Note that get_bad_ticks_message expects the first line to have an extra newline.
return (