Skip to content

Commit

Permalink
Docs: Update skip_comments to ignore_comments (#3145)
Browse files Browse the repository at this point in the history
In the docs, the `ignore_comments` parameter to `nlohmann::json::parse()` is described as `skip_comments`, which does not match the actual implementation. While the demo code compiles and works, the parameter name is wrong.
  • Loading branch information
daniel-kun authored Nov 17, 2021
1 parent fe23033 commit ee1208a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/mkdocs/docs/features/comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ However, you can pass set parameter `ignore_comments` to `#!c true` in the parse
}
```

When calling `parse` without additional argument, a parse error exception is thrown. If `skip_comments` is set to `#! true`, the comments are skipped during parsing:
When calling `parse` without additional argument, a parse error exception is thrown. If `ignore_comments` is set to `#! true`, the comments are ignored during parsing:

```cpp
#include <iostream>
Expand Down Expand Up @@ -55,7 +55,7 @@ However, you can pass set parameter `ignore_comments` to `#!c true` in the parse
json j = json::parse(s,
/* callback */ nullptr,
/* allow exceptions */ true,
/* skip_comments */ true);
/* ignore_comments */ true);
std::cout << j.dump(2) << '\n';
}
```
Expand All @@ -80,4 +80,4 @@ However, you can pass set parameter `ignore_comments` to `#!c true` in the parse
"Neptune"
]
}
```
```

0 comments on commit ee1208a

Please sign in to comment.