Improve doctest output #351
Open
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
|
This is what the improved output from doctest looks like after this PR (see https://github.com/compiler-research/xeus-cpp/actions/runs/15680986691/job/44172145178?pr=351#step:6:7636 for where I took the screenshot) |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #351 +/- ##
=======================================
Coverage 81.78% 81.78%
=======================================
Files 20 20
Lines 950 950
Branches 87 87
=======================================
Hits 777 777
Misses 173 173 🚀 New features to boost your workflow:
|
|
clang-tidy review says "All clean, LGTM! 👍" |
1 similar comment
|
clang-tidy review says "All clean, LGTM! 👍" |
mcbarton
force-pushed
the
Improve-doctest-output
branch
from
d5bb757 to
3c96cc6
Compare
|
clang-tidy review says "All clean, LGTM! 👍" |
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
Please include a summary of changes, motivation and context for this PR.
Currently the output from doctest isn't very useful, as it only gives a number of how many tests pass and fail at the end, and not a list of which tests fail (see image below). It is also hard to disentangle which output to the terminal is from which tests.
This PR fixes this by providing a custom doctest config, where we pass specific command line arguments to doctest via the method outlined in doctests documentation (see https://github.com/doctest/doctest/blob/master/doc/markdown/main.md )
In the case of the browser tests that xeus-cpp has, this is the only way to pass these command line arguments.
Fixes # (issue)
Type of change
Please tick all options which are relevant.