-
Notifications
You must be signed in to change notification settings - Fork 22
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
Improve error messages for bad maker calls #294
Merged
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
This covers situations where somebody calls a `QuantityMaker`, or `QuantityPointMaker`, on a value that isn't a valid rep. (One of the most common use cases is when the value is _already_ a core Au type, a `Quantity` or `QuantityMaker`, and the call is redundant. The first approach is a blanket approach: we start enforcing the "valid rep" definition that we had previously added. This already makes the error messages a lot nicer and shorter. We then go further for the most common use case of redundant maker calls. By adding templated overloads to each maker for `Quantity` and `QuantityPoint`, we can directly tell users what they did wrong. In order to implement these overloads, we needed an `AlwaysFalse` utliity, which we added along with unit tests. Helps #288. We will follow up to close this out by updating the troubleshooting guide.
Here are the example changes to tests, for posterity. Input codeTEST(Quantity, OfQuantityMakesNiceErrorMessage) {
radians(radians);
radians(radians(3.14));
meters(meters_pt(15));
meters_pt(meters_pt(51));
meters_pt(meters(51));
} Old error messages
New error messages
|
geoffviola
approved these changes
Sep 23, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The errors look a lot clearer. The test cases contains all the errors. This should improve usability.
Co-authored-by: Geoffrey Viola <[email protected]>
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.
This covers situations where somebody calls a
QuantityMaker
, orQuantityPointMaker
, on a value that isn't a valid rep. (One of themost common use cases is when the value is already a core Au type, a
Quantity
orQuantityMaker
, and the call is redundant.The first approach is a blanket approach: we start enforcing the "valid
rep" definition that we had previously added. This already makes the
error messages a lot nicer and shorter.
We then go further for the most common use case of redundant maker
calls. By adding templated overloads to each maker for
Quantity
andQuantityPoint
, we can directly tell users what they did wrong. Inorder to implement these overloads, we needed an
AlwaysFalse
utliity,which we added along with unit tests.
Helps #288. We will follow up to close this out by updating the
troubleshooting guide.