forked from jpwhite4/xdmod-python
-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Implement 100% test coverage. #27
Draft
RodneyCodess
wants to merge
17
commits into
ubccr:main
Choose a base branch
from
RodneyCodess:Test_coverage
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
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
aaronweeden
requested changes
Jun 17, 2024
aaronweeden
reviewed
Jun 24, 2024
aaronweeden
reviewed
Jun 24, 2024
This reverts commit df1f00e.
This reverts commit aacd5d6.
Co-authored-by: Aaron Weeden <[email protected]>
Co-authored-by: Aaron Weeden <[email protected]>
Co-authored-by: Aaron Weeden <[email protected]>
aaronweeden
force-pushed
the
Test_coverage
branch
from
October 30, 2024 19:57
6eb6a03
to
e072729
Compare
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
This PR updates codes and adds tests to sustain 100% code coverage by using a library
Coverage.py
.This PR makes changes, adds extra steps, and overall improves readability to the
docs/developing.md
to ensure correct procedure.Motivation and Context
The reason for this PR is to have completely 100% code coverage so that we can confidently change code knowing it won't break anything.
For any code that couldn't be tested, we used
# pragma: no cover
to bypass thecoverage report
.Tests performed
We ran our initial test and did a
coverage report
to figure out how much code we needed to cover. To completely cover our code, we added more tests and kept doingcoverage reports
until we finally got to 100% code coverage.Types of changes
Checklist:
CHANGELOG.md
has been updateddocs/developing.md
) produces no errorsxdmod-notebooks
repository as necessary, and the notebooks all run successfully