[ENH] Update compare method with low/upper bounds #191
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
added 2 commits
June 8, 2018 17:08
The compare method now accepts the following objects
to control the comparison:
- lower: lower bound on acceptable relative differences
- upper: upper bound on acceptable relative differences
Values with relative difference less than lower will be treated
as a success, greater than or equal to upper will be treated as
a failure, and in the middle will be warned but not a failure.
Added a developer guide that details how our comparison methods
should be implemented, and what types of messages should be
given for different scenarios
Added test_base_compare.py to perform some basic checks
regarding
- input types to the compare method
- input arguments
drewejohnson
added
documentation
enh - comparisons
testing
|
This is really great. Should be really useful to the serpent developers. |
DanKotlyar
approved these changes
Jun 8, 2018
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.
The compare method now accepts the following objects to control the comparison:
- lower: lower bound on acceptable relative differences
- upper: upper bound on acceptable relative differences
Values with relative difference less than lower will be treated as a success, greater than or equal to upper will be treated as a failure, and in the middle will be warned but not a failure.
Added a developer guide that details how our comparison methods should be implemented, and what types of messages should be given for different scenarios
Added test_base_compare.py to perform some basic checks regarding
- input types to the compare method
- input arguments