[API-535] test Docs py code blocks for correct API signatures #283
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.
Propose a basic first mini PyTest framework to test the sanity of the documentation (scraped from #AICW-17). For now the only proposed test checks if Cadwork symbols used in the Python blocks from
examples/
section have up-to-date API signatures, in the following way:E.g. in current state this file, containing
isWall
in the last py code block will be raised as an error and fail the action (left the typo just for showcase).PS: I agree that the best would be to run the examples in the python code, I do not see how rn, maybe in future..