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

Docs: Fix wrong code usage in the Value access section of json_pointer.md #4255

Merged
merged 1 commit into from
Apr 13, 2024

Conversation

Fallen-Breath
Copy link
Contributor

The code usage demo in the Value access section of the JSON Pointer document does not work correctly

https://json.nlohmann.me/features/json_pointer/#value-access

```cpp
// the JSON value from above
auto j = json::parse(R"({
"array": ["A", "B", "C"],
"nested": {
"one": 1,
"two": 2,
"three": [true, false]
}
})");
// access values
auto val = j["/"_json_pointer]; // {"array":["A","B","C"],...}
auto val1 = j["/nested/one"_json_pointer]; // 1
auto val2 = j.at[json::json_pointer("/nested/three/1")]; // false
auto val3 = j.value[json::json_pointer("/nested/four", 0)]; // 0
```

There are 3 mistakes in the code above:

  1. (line 74) The json pointer "/" does not point to the root object. Instead, it points to the value with an empty string as the key at the root object. It should be replaced with json pointer ""

    // empty string access
    CHECK(j[json::json_pointer("/")] == j[""]);

    // the whole document
    CHECK(j[json::json_pointer()] == j);
    CHECK(j[json::json_pointer("")] == j);

  2. (line 76) Incorrect usage of nlohmann::basic_json::at. It's a function and does not support the [] operator

  3. (line 77) Incorrect usage of nlohmann::basic_json::value. It's a function and does not support the [] operator. Additionally, the argument 0 as the default value for the value function is incorrectly placed

This PR resolves these 3 mistakes and makes the demo code work correctly


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 files single_include/nlohmann/json.hpp and single_include/nlohmann/json_fwd.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.7 (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 this kind of bug). 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.

@coveralls
Copy link

Coverage Status

coverage: 100.0%. remained the same
when pulling 4d6cae7 on Fallen-Breath:patch-1
into a259ecc 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.

Looks good to me.

@nlohmann nlohmann added this to the Release 3.11.4 milestone Apr 13, 2024
@nlohmann nlohmann merged commit 8c391e0 into nlohmann:develop Apr 13, 2024
107 of 110 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants