Skip to content

Commit

Permalink
fix up docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wolfv committed Jul 21, 2022
1 parent fd62620 commit fe31d31
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
1 change: 1 addition & 0 deletions docs/mkdocs/docs/api/basic_json/patch.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ is thrown. In any case, the original value is not changed: the patch is applied
- [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902)
- [RFC 6901 (JSON Pointer)](https://tools.ietf.org/html/rfc6901)
- [patch_inplace](patch_inplace.md) applies a JSON Patch without creating a copy of the document
- [merge_patch](merge_patch.md) applies a JSON Merge Patch
## Version history
Expand Down
9 changes: 3 additions & 6 deletions docs/mkdocs/docs/api/basic_json/patch_inplace.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# <small>nlohmann::basic_json::</small>patch
# <small>nlohmann::basic_json::</small>patch_inplace

```cpp
void patch_inplace(const basic_json& json_patch) const;
Expand All @@ -12,10 +12,6 @@ a JSON document. With this function, a JSON Patch is applied to the current JSON
`json_patch` (in)
: JSON patch document
## Return value
void
## Exception safety
No guarantees, value may be corrupted by an unsuccessful patch operation.
Expand All @@ -41,7 +37,7 @@ affected by the patch, the complexity can usually be neglected.
## Notes
Unlike `patch`, `patch_inplace` applies the operation "in place" and no copy of the json document is created. That makes it faster for large documents by avoiding the copy. However, the value of the json document might be corrupted if the function throws an exception.
Unlike [`patch`](patch.md), `patch_inplace` applies the operation "in place" and no copy of the JSON value is created. That makes it faster for large documents by avoiding the copy. However, the JSON value might be corrupted if the function throws an exception.
## Examples
Expand All @@ -63,4 +59,5 @@ Unlike `patch`, `patch_inplace` applies the operation "in place" and no copy of
- [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902)
- [RFC 6901 (JSON Pointer)](https://tools.ietf.org/html/rfc6901)
- [patch](patch.md) applies a JSON Merge Patch
- [merge_patch](merge_patch.md) applies a JSON Merge Patch

0 comments on commit fe31d31

Please sign in to comment.