Add doctests and acceptance tests to CI pipeline and fix broken doctests #244
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
- Add doctest step to run_unit_tests.yml workflow - Fix DigitalWaveformFailure doctest: remove column_index field that no longer exists in API - Fix _mask_to_column_indices doctest: add missing bitorder parameter This ensures doctests are run as part of CI to catch future API/documentation mismatches. Signed-off-by: Kosta Ilic <[email protected]>
With only 6 tests taking ~0.1s to run, acceptance tests provide valuable integration testing coverage for memory-mapping functionality across all OS/Python combinations with minimal CI overhead. Signed-off-by: Kosta Ilic <[email protected]>
KostaIlic2
changed the title
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.
What does this Pull Request accomplish?
I encountered unexpected doctest failures, and got copilot to fix them. To prevent this situation in the future, I got copilot to add doctests to the pipeline. I then tracked down that acceptance tests are also not in CI, so I had copilot add those too.
Summary of changes:
This ensures doctests are run as part of CI to catch future API/documentation mismatches. It also ensures acceptance tests are run as part of CI.
Why should this Pull Request be merged?
To reduce probability of incorrect documentation examples and surprises with acceptance tests in the future. And to unblock future contributions.
What testing has been done?
I leaned on draft PR pipeline build for required automated QA.
Root Cause Analysis
I asked copilot to figure out which PR broke doctests. Here is what it figured:
PR #222 "Reverse Indices for Digital Waveform Signals" broke the doctests
👤 Author: Mike Prosser (@mikeprosserni)
📅 Date: December 10, 2025 (9 days ago)
🔗 Commit: 0108c35