Move assertion messages into code and deprecate AssertionError #14030
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
|
📦 Preview the website for this branch here: https://deploy-preview-14030--ol-site.netlify.app/. |
tschaub
approved these changes
Aug 21, 2022
tschaub
reviewed
Aug 21, 2022
src/ol/AssertionError.js
Outdated
| '/doc/errors/#' + | ||
| code + | ||
| ' for details.'; | ||
| const message = `Assertion failed. ${messages[code]}.`; |
There was a problem hiding this comment.
I'd be in favor of simplifying this to just messages[code]. I think the "Assertion failed" part of the message isn't meaningful and potentially confusing to users.
tschaub
reviewed
Aug 22, 2022
changelog/upgrade-notes.md
Outdated
| Future versions will no longer throw `ol/AssertionError` with an error `code`. Instead, they will throw `Error` with just the error message. | ||
|
|
||
| ### v7.0.0 | ||
|
|
There was a problem hiding this comment.
Indeed. I just rebased the pull request.
tschaub
approved these changes
Aug 22, 2022
ahocevar
force-pushed
the
assert-messages
branch
2 times, most recently
from
0165885
to
bb5eaac
Compare
ahocevar
force-pushed
the
assert-messages
branch
from
bb5eaac
to
a04ff79
Compare
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.
Fixes #14028.
I think it's best to keep the same codes for now, even though some are duplicated, in case anyone relies on them. And to deprecate
ol/AssertionErrorin favor of throwing plainErrors instead, starting with the next major version. What do others think?