docs: Improve documentation of Testplan.get_percentage#222
Merged
Conversation
AlexJones0
approved these changes
May 21, 2026
| if value < 0: | ||
| raise ValueError("Cannot represent negative fraction") | ||
|
|
||
| return "-- %" if total == 0 else f"{round(100 * value / total, 2):.2f} %" |
Contributor
There was a problem hiding this comment.
I'm pretty sure the round here is pointless - that's what the 2 in the format specifier is doing.
Python actually has a nifty format specifier for almost exactly this case:
Suggested change
| return "-- %" if total == 0 else f"{round(100 * value / total, 2):.2f} %" | |
| return "--%" if total == 0 else f"{value / total:.2%}" |
But then you drop the space between the number and the % symbol. You could do:
Suggested change
| return "-- %" if total == 0 else f"{round(100 * value / total, 2):.2f} %" | |
| return "--%" if total == 0 else f"{value / total:.2%}".replace("%", " %") |
Though that's about as much effort as the original.
Contributor
Author
There was a problem hiding this comment.
Good point about the rounding! Let's keep the multiplication by 100 (for now, at least). It's possibly more explicit anyway: I'm a bit ambivalent about using format specifiers that change the number.
Also, add two error conditions (for fractions that don't make sense). Signed-off-by: Rupert Swarbrick <rswarbrick@lowrisc.org>
9b39f20 to
28ebe03
Compare
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
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.
Also, add two error conditions (for fractions that don't make sense).