From b6d00d18974358ab1d55dcc3379d0ee3052deb4e Mon Sep 17 00:00:00 2001 From: Niels Lohmann Date: Mon, 6 Jun 2022 16:46:55 +0200 Subject: [PATCH] Small documentation fixes (#3520) --- README.md | 3 ++- docs/mkdocs/docs/features/json_pointer.md | 7 +++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bed9b4911..1f4ea0e61 100644 --- a/README.md +++ b/README.md @@ -1622,6 +1622,7 @@ I deeply appreciate the help of the following people. - [Andrea Cocito](https://github.com/puffetto) added a clarification on macro usage to the documentation. - [Krzysiek Karbowiak](https://github.com/kkarbowiak) refactored the tests to use `CHECK_THROWS_WITH_AS`. - [Chaoqi Zhang](https://github.com/prncoprs) fixed a typo. +- [ivanovmp](https://github.com/ivanovmp) fixed a whitespace error. Thanks a lot for helping out! Please [let me know](mailto:mail@nlohmann.me) if I forgot someone. @@ -1656,7 +1657,7 @@ The library itself consists of a single header file licensed under the MIT licen ## Projects using JSON for Modern C++ -The library is currently used in Apple macOS Sierra and iOS 10. I am not sure what they are using the library for, but I am happy that it runs on so many devices. +The library is currently used in Apple macOS Sierra-Monterey and iOS 10-15. I am not sure what they are using the library for, but I am happy that it runs on so many devices. ## Notes diff --git a/docs/mkdocs/docs/features/json_pointer.md b/docs/mkdocs/docs/features/json_pointer.md index a7861ec7d..a3980b4c6 100644 --- a/docs/mkdocs/docs/features/json_pointer.md +++ b/docs/mkdocs/docs/features/json_pointer.md @@ -18,11 +18,11 @@ Consider the following JSON document } ``` -Then every value inside the JSON document can be idientified as follows: +Then every value inside the JSON document can be identified as follows: | JSON Pointer | JSON value | |-------------------|----------------------------------------------------------------------------------| -| `/` | `#!json {"array":["A","B","C"],"nested":{"one":1,"two":2,"three":[true,false]}}` | +| `` | `#!json {"array":["A","B","C"],"nested":{"one":1,"two":2,"three":[true,false]}}` | | `/array` | `#!json ["A","B","C"]` | | `/array/0` | `#!json A` | | `/array/1` | `#!json B` | @@ -34,6 +34,9 @@ Then every value inside the JSON document can be idientified as follows: | `/nested/three/0` | `#!json true` | | `/nested/three/1` | `#!json false` | +Note `/` does not identify the root (i.e., the whole document), but an object entry with empty key `""`. See +[RFC 6901](https://tools.ietf.org/html/rfc6901) for more information. + ## JSON Pointer creation JSON Pointers can be created from a string: