Detect More Faulty Codeblocks#3514
Open
SamuelRoettgermann wants to merge 3 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Preface
Originally part of #3513 , but the main feature of that PR still needs some tuning.
Summary
This PR extends what kind of codeblock mistakes are detected.
Current system
Our current system only detects unformatted code blocks if they
A) have 3 backticks at the front and back, but do not specify a language or
B) don't have any backticks at all (and the entire message is valid Python code)
Proposed system
This PR extends this to also detect unformatted code blocks if they:
C) have N (N != 3) backticks at the front and back or
D) have any sort of whitespace after the language specifier rather than just a newline
Examples
With these changes the bot now also detects common mistakes such as:
`¶
x·=·4¶
y·=·3¶
z·=·4¶
print("abc")¶
`¶
or:
```py·¶
x·=·4¶
y·=·3¶
z·=·4¶
print("abc")¶
```¶
that were previously not detected.