[util] added doc test utility#177
Merged
FrankLeeeee merged 3 commits intomainfrom Feb 27, 2023
Merged
Conversation
binmakeswell
approved these changes
Feb 27, 2023
1 task
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.
This PR added a utility command to test the markdown file.
If you want to test the Python code in your markdown file, you need to provide a command to trigger the test. Do add the following line to the top of your file and replace
$commandwith the actual command. Do note that the markdown will be converted into a Python file. Assuming you have ademo.mdfile, the test file generated will bedemo.py. Therefore, you should usedemo.pyin your command, e.g.python demo.py.<!-- doc-test-command: $command -->Meanwhile, only code labelled as a Python code block will be considered for testing.
Lastly, if you want to skip some code, you just need to add the following annotations to tell
docerto discard the wrapped code for testing.