Implement basic support for documentation tests #1971
Closed
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.
From the outside, it is currently very hard to find out how much of the syntax described in the documentation is actually implemented by the Explorer (as also evidenced by #1891). And even if this was known, documentation and implementation are likely to drift over time as things evolve.
This PR provides:
py_binary
target implementing the above DSLbazel test docs/...
automatically generate and execute these testsThe idea would then be, over time, to mark (at least some of) the example code in the documentation as tests, and have Bazel test automatically that the syntax used in the documentation is in fact valid.
TODO