test(readme): add test for the example in the readme #91
Conversation
This file contains 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
gilrrei
force-pushed
the
add_test_for_readme_example
branch
from
4d496ba to
0d6a3bf
Compare
maxdinkel
reviewed
Jan 10, 2025
leahaeusel
reviewed
Jan 10, 2025
gilrrei
force-pushed
the
add_test_for_readme_example
branch
from
a8f7fb0 to
dd0ed51
Compare
leahaeusel
reviewed
Jan 10, 2025
tests/input_files/third_party/fourc/coarse_plate_dirichlet_template.dat
Outdated
Show resolved
Hide resolved
tests/input_files/third_party/fourc/coarse_plate_dirichlet_template.dat
Outdated
Show resolved
Hide resolved
sbrandstaeter
requested changes
Jan 10, 2025
gilrrei
force-pushed
the
add_test_for_readme_example
branch
from
dd0ed51 to
fb0a743
Compare
sbrandstaeter
previously approved these changes
Jan 10, 2025
leahaeusel
previously approved these changes
Jan 10, 2025
maxdinkel
reviewed
Jan 10, 2025
gilrrei
dismissed stale reviews from leahaeusel and sbrandstaeter
via
edce564
gilrrei
force-pushed
the
add_test_for_readme_example
branch
from
fb0a743 to
edce564
Compare
maxdinkel
approved these changes
Jan 10, 2025
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.
Description and Context
This PR adds a test for the QUEENS example in the readme. It does not check if the output is correct, only if it runs without exit code. This is to ensure that the example remains working and highlights if this is not the case.
The function to extract the source from the readme could also be added to the
conf.pyof the sphinx documentation to add this example as a tutorial.Related Issues and Pull Requests
How Has This Been Tested?
Checklist
Additional Information
Interested Parties
Possible reviewers: @leahaeusel @sbrandstaeter @maxdinkel
Other interested parties: