Fixes a bug in the doctest runner where error messages were suppressed. #1791
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
**Bug Report** * **File**: `openage/testing/doctest.py` * **Line**: 20 * **Description**: The `testmod` function was called with `report=False`, which suppresses detailed output of doctest failures. This makes it difficult to debug failing doctests, as the only output is a generic `TestError`. * **Fix**: Removed the `report=False` argument from the `testmod` call to enable detailed reporting of doctest failures. **Verification** 1. Created a new doctest that was designed to fail. 2. Ran the tests and confirmed that the error message was generic. 3. Applied the fix. 4. Ran the tests again and confirmed that the error message was detailed and specific. 5. Removed the failing doctest. 6. Ran the tests one last time to ensure everything passed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Bug Report
openage/testing/doctest.pytestmodfunction was called withreport=False, which suppresses detailed output of doctest failures. This makes it difficult to debug failing doctests, as the only output is a genericTestError.report=Falseargument from thetestmodcall to enable detailed reporting of doctest failures.Verification