-
-
Notifications
You must be signed in to change notification settings - Fork 6.8k
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
The type json is missing from the html documentation #1616
Comments
This is the first time I heard of someone asking for documentation of the What do you expect instead? |
One correction: When I copied the documentation link, I meant https://nlohmann.github.io/json/, not https://nlohmann.github.io/json/classnlohmann_1_1basic__json.html. I'm not sure where the latter came from. So I meant that your html documentation in general doesn't have the json typedef documented.
I don't think that it is a particularly good measure of a need in a situation when everyone who doesn't find what he's looking for has a ton of alternative libraries. I understand how you could think that in the absence of other feedback though.
I thing you should link to this type (json, not basic_json) from as many places as possible, because this is the central type to your library. From my experience in the industry, the people who don't really know C++ but need to use it outnumber those who really know it 5 to 1. They won't automatically know that json is basic_json. |
🔖 Release itemThis issue/PR will be part of the next release of the library. This template helps preparing the release notes. Type
Description
|
I added a note to the API documentation. It will be part of the next release. |
The examples in the README mention type json as the most basic type to use by default in order to use the library. The problem is that the linked documentation https://nlohmann.github.io/json/classnlohmann_1_1basic__json.html does not document this type.
This is certain to confuse anyone newbie. I'm willing to bet a beer that you are loosing 20% of newcomers because of this, particularly those who are new to C++.
Note: This is not about whether I can find the information for myself. I found out from the code that json is defined as "using json= basic_json<>;" and looked up the docs of basic_json. This is a quality of documentation issue that affects others.
Look at the README and try to use the library. Then try to look up members of type json in https://nlohmann.github.io/json/classnlohmann_1_1basic__json.html.
I expect https://nlohmann.github.io/json/classnlohmann_1_1basic__json.html to contain documentation of the json type (for example mentioning that json is a typedef for basic_json).
https://nlohmann.github.io/json/classnlohmann_1_1basic__json.html does not document the name json.
all OSes and compilers
develop
branch?The released version.
no
The text was updated successfully, but these errors were encountered: