Skip to content

Commit

Permalink
📝 improve documentation InputType and IteratorType
Browse files Browse the repository at this point in the history
  • Loading branch information
nlohmann committed Jan 4, 2022
1 parent 9e89c2f commit 10486ab
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
6 changes: 5 additions & 1 deletion doc/mkdocs/docs/api/basic_json/accept.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,14 @@ Unlike the [`parse`](parse.md) function, this function neither throws an excepti
- a `FILE` pointer
- a C-style array of characters
- a pointer to a null-terminated string of single byte characters
- a `std::string`
- an object `obj` for which `begin(obj)` and `end(obj)` produces a valid pair of iterators.
`IteratorType`
: a compatible iterator type
: a compatible iterator type, for instance.
- a pair of `std::string::iterator` or `std::vector<std::uint8_t>::iterator`
- a pair of pointers such as `ptr` and `ptr + len`
## Parameters
Expand Down
1 change: 1 addition & 0 deletions doc/mkdocs/docs/api/basic_json/parse.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ static basic_json parse(IteratorType first, IteratorType last,
- a `FILE` pointer
- a C-style array of characters
- a pointer to a null-terminated string of single byte characters
- a `std::string`
- an object `obj` for which `begin(obj)` and `end(obj)` produces a valid pair of iterators.
`IteratorType`
Expand Down

0 comments on commit 10486ab

Please sign in to comment.