Repository navigation
docs: add validator demo GIF to README - #7
Merged
Merged
Conversation
Adds docs/assets/plc-demo.gif (recorded against v0.2.0 with vhs) under '## The validator', plus the vhs tape that re-records it.
|
Caution Review failedThe pull request is closed.
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. |
Merged
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.
Adds a short terminal demo of the validator to the README.
docs/assets/plc-demo.gif(800×480, ~26 s, 147 KB), embedded directly under## The validator.What it shows:
FB_Pumphas anIF … ELSIFblock with noEND_IF.python3 plc-programming/scripts/plc_validate.py pump.streportserror ST002: IF opened at line 10 is not closed before END_FUNCTION_BLOCK(exit 1). The AI edit addsEND_IF;and is shown as adiff -u. The same command then reports 0 errors (exit 0).Recorded against v0.2.0. Both validator runs are real output. The fix step is the AI edit shown as a diff (scripted in the tape), not an auto-fix command; the plugin has none.
README change is one image line; nothing else is touched.
python3 -m unittest discover -s tests: 276 tests OK.