Skip to content
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

Don't round small values in print summary #2093

Merged
merged 4 commits into from
Nov 29, 2023

Conversation

uri-granta
Copy link
Contributor

PR type: bugfix

Related issue(s)/PRs:

Summary

Proposed changes

PR #1924 resulted in values in print summary being truncated to 5 decimal places, which is a problem for eg small variances. This PR prevents rounding for values less than 1.

What alternatives have you considered?

Arguably any rounding is unnecessary. However, the print summary tests currently have hardcoded expecations and fail when run on MacOS if the values aren't rounded. Since the values are meant to be human readable there is no harm in rounding large values.

Release notes

Fully backwards compatible: yes

If not, why is it worth breaking backwards compatibility:

PR checklist

  • New features: code is well-documented
    • detailed docstrings (API documentation)
    • notebook examples (usage demonstration)
  • The bug case / new feature is covered by unit tests
  • Code has type annotations
  • Build checks
    • I ran the black+isort formatter (make format)
    • I locally tested that the tests pass (make check-all)
  • Release management
    • RELEASE.md updated with entry for this change
    • New contributors: I've added myself to CONTRIBUTORS.md

Copy link

codecov bot commented Nov 27, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (78ab87c) 98.19% compared to head (a90aa72) 98.19%.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #2093   +/-   ##
========================================
  Coverage    98.19%   98.19%           
========================================
  Files           97       97           
  Lines         5486     5486           
========================================
  Hits          5387     5387           
  Misses          99       99           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@khurram-ghani khurram-ghani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

@uri-granta uri-granta merged commit 5d4c222 into develop Nov 29, 2023
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants