Cosmetic: improve exception traceback readability #80
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
Codecov Report
@@ Coverage Diff @@
## main #80 +/- ##
==========================================
- Coverage 99.19% 99.06% -0.13%
==========================================
Files 9 9
Lines 741 745 +4
==========================================
+ Hits 735 738 +3
- Misses 6 7 +1
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
carterbox
suggested changes
Dec 29, 2022
| @@ -124,7 +124,8 @@ def naturaldelta( | |||
| """ | |||
| tmp = Unit[minimum_unit.upper()] | |||
| if tmp not in (Unit.SECONDS, Unit.MILLISECONDS, Unit.MICROSECONDS): | |||
| raise ValueError(f"Minimum unit '{minimum_unit}' not supported") | |||
| msg = f"Minimum unit '{minimum_unit}' not supported" | |||
There was a problem hiding this comment.
Suggested change
| msg = f"Minimum unit '{minimum_unit}' not supported" | |
| msg = f"Minimum unit '{minimum_unit}' not supported." |
| raise ValueError( | ||
| "Minimum unit is suppressed and no suitable replacement was found" | ||
| ) | ||
| msg = "Minimum unit is suppressed and no suitable replacement was found" |
There was a problem hiding this comment.
Suggested change
| msg = "Minimum unit is suppressed and no suitable replacement was found" | |
| msg = "Minimum unit is suppressed, and no suitable replacement was found." |
|
I think the single sentence exception messages are fine without a full stop at the end. If there are two or more sentences, then it's needed. A quick search of CPython source code suggests the vast majority (~95%) do not end with a full stop: $ # Ending with a full stop
$ git grep "raise .*Error(.*\.['\"])" Lib | wc -l
79
$ # Ending with no full stop
$ git grep "raise .*Error(.*[^\.]['\"])" Lib | wc -l
1609 |
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.
Changes proposed in this pull request: