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

Standardize Exception Messages #486

Merged
merged 1 commit into from
Sep 25, 2019

Conversation

johnjaylward
Copy link
Contributor

@johnjaylward johnjaylward commented Sep 17, 2019

What problem does this code solve?
Simply standardizes error messages when data types don't match expected value types. I.e. someone tries to convert the string "bob" to an int value.

Risks
None.

Changes to the API?
No.

Will this require a new release?
Not immediately.

Should the documentation be updated?
No.

Does it break the unit tests?
Yes. There were corrections needed to match the new string values of the messages. See: stleary/JSON-Java-unit-test#95

Was any code refactored in this commit?
Yes. The exception code was pulled out to a common function similar to the syntaxError function used in the Tokeners.

Review status
APPROVED

@johnjaylward johnjaylward force-pushed the StandardizeExceptionMessages branch from e43da60 to e9c27ab Compare September 17, 2019 15:08
@stleary
Copy link
Owner

stleary commented Sep 17, 2019

Starting 7 day comment window.
Normally a 3 day window is sufficient, but this change could potentially break user applications. However, probably only if they are using test automation that expects exact wording in exceptions. Appropriate text should be included in the release text.
Users who think this could cause them problems are welcome to comment here during the window.

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.

2 participants