Skip to content

docs : fix heading for conversions to/from arbitrary types in README #4936

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
+2 −2
Open

docs : fix heading for conversions to/from arbitrary types in README #4936

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -769,7 +769,7 @@ json j_default = ch; // stores integer number 65
json j_string = std::string(1, ch); // stores string "A"
```

### Arbitrary types conversions
## Conversions to/from arbitrary types

Every type can be serialized in JSON, not just STL containers and scalar types. Usually, you would do something along those lines:

Expand Down Expand Up @@ -1066,7 +1066,7 @@ json jPi = 3.14;
assert(jPi.template get<TaskState>() == TS_INVALID);
```

Just as in [Arbitrary Type Conversions](#arbitrary-types-conversions) above,
Just as in [Arbitrary Type Conversions](#conversions-tofrom-arbitrary-types) above,

- `NLOHMANN_JSON_SERIALIZE_ENUM()` MUST be declared in your enum type's namespace (which can be the global namespace), or the library will not be able to locate it, and it will default to integer serialization.
- It MUST be available (e.g., proper headers must be included) everywhere you use the conversions.
Expand Down