External/json
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

📝 add migration guide

Browse Source
This commit is contained in:
Niels Lohmann 2022-08-14 13:13:14 +02:00
parent 7836f57bbd
commit e15aad910a
No known key found for this signature in database
GPG Key ID: 7F3CEA63AE251B69
2 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/labeler.yml vendored
View File

@ -13,6 +13,6 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: srvaroa/labeler@master - uses: falbrechtskirchinger/labeler@master
env: env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

20
docs/mkdocs/docs/integration/migration_guide.md
View File

@ -4,8 +4,8 @@ This page collects some guidelines on how to future-proof your code for future v
## Replace deprecated functions ## Replace deprecated functions
The following functions have been deprecated and will be removed in the next major version (i.e., 4.0.0). All The following functions have been deprecated in earlier versions and will be removed in the next major version (i.e.,
deprecations are annotated with 4.0.0). All deprecations are annotated with
[`HEDLEY_DEPRECATED_FOR`](https://nemequ.github.io/hedley/api-reference.html#HEDLEY_DEPRECATED_FOR) to report which [`HEDLEY_DEPRECATED_FOR`](https://nemequ.github.io/hedley/api-reference.html#HEDLEY_DEPRECATED_FOR) to report which
function to use instead. function to use instead.
@ -53,10 +53,11 @@ function to use instead.
#### JSON Pointers #### JSON Pointers
- Comparing JSON pointers with strings using the string overload of [`operator==`](../api/json_pointer/operator_eq.md) - Comparing JSON Pointers with strings via [`operator==`](../api/json_pointer/operator_eq.md) and
and [`operator!=`](../api/json_pointer/operator_ne.md) is deprecated since 3.11.2. To compare a [`operator!=`](../api/json_pointer/operator_ne.md) is deprecated since 3.11.2. To compare a
[`json_pointer`](../api/json_pointer/index.md) `p` with a string `s`, convert `s` to a `json_pointer` first, then [`json_pointer`](../api/json_pointer/index.md) `p` with a string `s`, convert `s` to a `json_pointer` first and use
compare the two JSON pointers. [`json_pointer::operator==`](../api/json_pointer/operator_eq.md) or
[`json_pointer::operator!=`](../api/json_pointer/operator_ne.md).
=== "Deprecated" === "Deprecated"
@ -197,6 +198,10 @@ conversions with calls to [`get`](../api/basic_json/get.md), [`get_to`](../api/b
j.get_to(s); j.get_to(s);
``` ```
You can prepare existing code by already defining
[`JSON_USE_IMPLICIT_CONVERSIONS`](../api/macros/json_use_implicit_conversions.md) to `0` and replace any implicit
conversions with calls to [`get`](../api/basic_json/get.md).
## Import namespace `literals` for UDLs ## Import namespace `literals` for UDLs
The user-defined string literals [`operator""_json`](../api/operator_literal_json.md) and The user-defined string literals [`operator""_json`](../api/operator_literal_json.md) and
@ -219,6 +224,9 @@ string literals into scope where needed.
nlohmann::json j = "[1,2,3]"_json; nlohmann::json j = "[1,2,3]"_json;
``` ```
To prepare existing code, define [`JSON_USE_GLOBAL_UDLS`](../api/macros/json_use_global_udls.md) to `0` and bring the
string literals into scope where needed.
## Do not hard-code the complete library namespace ## Do not hard-code the complete library namespace
The [`nlohmann` namespace](../features/namespace.md) contains a sub-namespace to avoid problems when different The [`nlohmann` namespace](../features/namespace.md) contains a sub-namespace to avoid problems when different