Improve docstring test legibility for junior devs #1750
Merged
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.
Changes
tl;dr Improves the state of #1570 by outputting the example docstring spec on failure & generally improving test clarity
Path.read_text
to immediately close source files after readHow to test
python -m
line from any example(s) inarcade/examples
or one of its immediate child folders, except forperf_test
and internationalization example files / folders../make.py test
check_code_docstring
in the outputFollow-up work
While working on this PR, I discovered the following problems:
arcade.gui.examples.*
) are not covered by the test due to the test assuming all examples are in the same folder.arcade.examples.gl.ray_marching.*
) is brokenGeneralized Docstring Check Functionality?
I do not know what @eruvanos is planning to do with the example structure. The second two problems may be best handled by refactoring the test to: