Code block: clarify get_instructions's docstring

It wasn't clear that it also parses the message content.

1 files changed, 5 insertions, 1 deletions

diff --git a/bot/cogs/codeblock/instructions.py b/bot/cogs/codeblock/instructions.py
index 4ea5ca094..c25b2af5d 100644
--- a/bot/cogs/codeblock/instructions.py
+++ b/bot/cogs/codeblock/instructions.py
@@ -147,7 +147,11 @@ def _get_no_lang_message(content: str) -> Optional[str]:
 
 
 def get_instructions(content: str) -> Optional[str]:
-    """Return code block formatting instructions for `content` or None if nothing's wrong."""
+    """
+    Parse `content` and return code block formatting instructions if something is wrong.
+
+    Return None if `content` lacks code block formatting issues.
+    """
     log.trace("Getting formatting instructions.")
 
     blocks = parsing.find_code_blocks(content)