Harmonize most doctests with Pint's current behavior #1116
Merged
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
rounding after 9 digits will make doctests more stable and less prone to subtle floating point errors whenever they reference a magnitude's repr() repr() for ints and numpy array magnitudes unchanged
doctests updated for new 9-digit Quantity().__repr__() added dependency on Serialize to requirements_docs.txt in systems.rst: three errors remain, one may be a regression, the others I'm not qualified to comment on in nonmult.rst: some issues around floating point estimation are made more robust by using print() seems like Quantity().__repr__() changed since these tests were written, and could benefit from some floating-point truncation in pitheorem.rst the only error was dictionary ordering, which is now deterministic in python3.7, but may still cause issues down the line no doctests in getting.rst, marked all as code blocks
now the example runs correctly under doctests
clarkgwillison
changed the title
|
@hgrecco this is ready for review |
|
This is awesome! |
|
bors r+ |
|
Build succeeded: |
|
This PR also resolved #1101 |
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.
black -t py36 . && isort -rc . && flake8with no errorsThis PR partially addresses #947, #972, and #990
After merging, the number of failing doctests in the Sphinx documentation should go from 92 (as mentioned in #947) down to 3:
Which will put us well in reach of enabling doctests in Travis to prevent documentation regressions in the future.
Most tests were fixed in this PR by deferring to the current behavior of Pint, however
Quantity.__repr__()was modified to round floating point magnitudes to 9 digits to avoid several test failures that were being caused by floating point ambiguities.Issue #1115 was opened to track the 3 tests that I could not easily resolve. Once that issue is resolved, we can enable doctests in Travis without breaking CI.