demo #1
Merged
demo #1
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
m-hurlow
force-pushed
the
auto-docs-for-tests
branch
from
c3c9824 to
7c33929
Compare
m-hurlow
force-pushed
the
auto-docs-for-tests
branch
from
7c33929 to
169c51c
Compare
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 is a demo of auto generating docs from tests.
It's 'opt-it', where each test requires
self.docs_from_test(locals())at the end to export the test.After running tests as follows:
python3 -m unittest evaluation_function.evaluation_test > test_to_docs.jsonA json is created with the test data. That can easily be converted to a markdown table by the eval docs loader.
I don't know the best place to put the json - it's just a demo.
If you think this approach works, we can suggest it to Andreas to generalise in the boiler plate, and push to the other existing repos.