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

Newer serialization macros not listed in README #4260

Open
2 tasks done
gregmarr opened this issue Jan 4, 2024 · 2 comments · May be fixed by #4560
Open
2 tasks done

Newer serialization macros not listed in README #4260

gregmarr opened this issue Jan 4, 2024 · 2 comments · May be fixed by #4560
Assignees
Labels
documentation kind: bug solution: proposed fix a fix for the issue has been proposed and waits for confirmation

Comments

@gregmarr
Copy link
Contributor

gregmarr commented Jan 4, 2024

Description

As described in #4235 , the README only lists NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE and NLOHMANN_DEFINE_TYPE_INTRUSIVE. There are now 6 macros.

There is documentation for these other 4, so it could just link to the documentation for more info on the other 4, rather than expanding the examples to cover all of them.

Also, only the two mentioned in the readme have @brief macro tags, rather than all 6, and the order of the intrusive versions doesn't match the order of the non-intrusive versions.

Reproduction steps

n/a

Expected vs. actual results

n/a

Minimal code example

No response

Error messages

No response

Compiler and operating system

n/a

Library version

a259ecc

Validation

@nlohmann nlohmann added solution: proposed fix a fix for the issue has been proposed and waits for confirmation and removed solution: proposed fix a fix for the issue has been proposed and waits for confirmation labels Jan 3, 2025
@nlohmann nlohmann self-assigned this Jan 4, 2025
@nlohmann
Copy link
Owner

nlohmann commented Jan 4, 2025

I overworked the documentation for the serialization macros in #4560. As such:

This all should close this issue, but definitely needs some review...

@nlohmann nlohmann added the solution: proposed fix a fix for the issue has been proposed and waits for confirmation label Jan 4, 2025
@nikhilreddydev
Copy link
Contributor

The documentation is now clear and very organized.
Looks good to me.
Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation kind: bug solution: proposed fix a fix for the issue has been proposed and waits for confirmation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants