Abbreviate codeblock instructions; remove ability to dismiss the inst… #3232
Conversation
…ructions with emoji. The more concise instructions are intended to be easier to read and increase the rate of followthru. That the instructions cannot be dismissed is intended to make them harder to ignore.
swfarnsworth
added
a: information
| @@ -177,7 +164,4 @@ def get_instructions(content: str) -> str | None: | |||
| if not instructions: | |||
| instructions = _get_no_lang_message(block.content) | |||
|
|
|||
| if instructions: | |||
| instructions += "\nYou can **edit your original message** to correct your code block." | |||
There was a problem hiding this comment.
Do you think this line was ineffective? The intent was to avoid spamming the channel with several attempts to fix their message. I don't know a better way to communicate this.
There was a problem hiding this comment.
I moved this instruction to the title for the embed.
There was a problem hiding this comment.
Oh I need to read more carefully, sorry!
There was a problem hiding this comment.
No problem; thank you for having written the original code in such a way that the changes in this PR were straightforward to make.
|
This is just documenting an edge case for the parser (it seems to think the docstring is the code block). |
|
Updated cases:
|
|
@mbaruh do you have any conscientious objections to the changes? |
|
Considering single newlines are rendered in embeds too (#3172), replacing the double newlines should help reduce the vertical height a bit. I also think the "this will result in the following" section is unnecessary when the user (incorrectly) attempts to use a codeblock since it's often triggered by users right after being told to use a codeblock at all. On a related note, I think adding something along the lines of "you can copy-paste the example in this embed if you're having trouble with formatting" might help as well. |
swfarnsworth
removed
the
review: do not merge
…ructions with emoji.
The more concise instructions are intended to be easier to read and increase the rate of followthru. That the instructions cannot be dismissed is intended to make them harder to ignore.
The spelling of "followthru" is very intentional.
I should probably remove the "It looks like you ..." from this one.
I'm not sure if this one should have the example. I should add the "Check this out to find the backtick key" from the
!codeembed.