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

Better error 305 #1221

Merged
merged 3 commits into from
Sep 18, 2018
Merged

Better error 305 #1221

merged 3 commits into from
Sep 18, 2018

Conversation

rivertam
Copy link
Contributor

@rivertam rivertam commented Aug 30, 2018

Improve error 305 to address #1220

closes #1220


Pull request checklist

Read the Contribution Guidelines for detailed information.

  • Changes are described in the pull request, or an existing issue is referenced.
  • The test suite compiles and runs without error.
  • Code coverage is 100%. Test cases can be added by editing the test suite.
  • The source code is amalgamated; that is, after making changes to the sources in the include/nlohmann directory, run make amalgamate to create the single-header file single_include/nlohmann/json.hpp. The whole process is described here.

Please don't

  • The C++11 support varies between different compilers and versions. Please note the list of supported compilers. Some compilers like GCC 4.8 (and earlier), Clang 3.3 (and earlier), or Microsoft Visual Studio 13.0 and earlier are known not to work due to missing or incomplete C++11 support. Please refrain from proposing changes that work around these compiler's limitations with #ifdefs or other means.
  • Specifically, I am aware of compilation problems with Microsoft Visual Studio (there even is an issue label for these kind of bugs). I understand that even in 2016, complete C++11 support isn't there yet. But please also understand that I do not want to drop features or uglify the code just to make Microsoft's sub-standard compiler happy. The past has shown that there are ways to express the functionality such that the code compiles with the most recent MSVC - unfortunately, this is not the main objective of the project.
  • Please refrain from proposing changes that would break JSON conformance. If you propose a conformant extension of JSON to be supported by the library, please motivate this extension.
  • Please do not open pull requests that address multiple issues.

@rivertam
Copy link
Contributor Author

rivertam commented Aug 30, 2018

This obviously doesn't give as much information as possible. I don't dynamically get the type of the argument. I don't really think that information would serve the user very well.

That said, "key-style" is, in my opinion, somewhat ambiguous. I wanted to say "string" or "string-like", but I don't know if that covers all the possible types it could be.

@gregmarr
Copy link
Contributor

I think having string in the error would be fine, since JSON says that object keys are strings.

@coveralls
Copy link

coveralls commented Aug 30, 2018

Coverage Status

Coverage remained the same at 100.0% when pulling 8f07ab6 on rivertam:better-error-305 into d713727 on nlohmann:develop.

Copy link
Owner

@nlohmann nlohmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @gregmarr: please use with a string argument instead of with a key-style argument.

@nlohmann
Copy link
Owner

nlohmann commented Sep 8, 2018

I have one question regarding this PR: Do the explanatory strings of exceptions belong to the public API of the library? If so, wouldn't changing be only allowed with a major release?

@nlohmann nlohmann added the state: please discuss please discuss the issue or vote for your favorite option label Sep 9, 2018
@nlohmann
Copy link
Owner

@rivertam Could you update the PR with respect to #1221 (review)?

@rivertam
Copy link
Contributor Author

@nlohmann Whoops, just saw this. Will do!

@nlohmann nlohmann removed the state: please discuss please discuss the issue or vote for your favorite option label Sep 18, 2018
@nlohmann nlohmann self-assigned this Sep 18, 2018
@nlohmann nlohmann added this to the Release 3.2.1 milestone Sep 18, 2018
@nlohmann nlohmann merged commit 7fa3b88 into nlohmann:develop Sep 18, 2018
@nlohmann
Copy link
Owner

Thanks!

@rivertam rivertam deleted the better-error-305 branch September 18, 2018 13:55
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.

Somewhat unhelpful error message "cannot use operator[] with object"
4 participants