Skip to content

Commit 3608ee4

Browse files
committed
docs: mention JSON Pointer and JSON Patch in quick start
1 parent 19c843c commit 3608ee4

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Quick Start
22

3-
This page gets you started using JSONPath wih Python, see [JSONPath Syntax](syntax.md) for information on JSONPath selector syntax.
3+
This page gets you started using JSONPath, JSON Pointer and JSON Patch wih Python, see [JSONPath Syntax](syntax.md) for information on JSONPath selector syntax.
44

55
## `findall(path, data)`
66

@@ -238,7 +238,7 @@ Apply a JSON Patch ([RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902)) t
238238

239239
_patch_ can be a string or file-like object containing a valid JSON Patch document, or an iterable of dictionaries.
240240

241-
_data_ is the target JSON document to modify. It can be a file-like object or string containing JSON formatted data, or equivalent Python objects. **_data_ is modified in-place**.
241+
_data_ is the target JSON document to modify. If _data_ is a string or file-like object, it will be loaded with _json.loads_. Otherwise _data_ should be a JSON-like data structure and will be **modified in place**.
242242

243243
```python
244244
from jsonpath import patch

jsonpath/patch.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -515,9 +515,9 @@ def apply(
515515
516516
If _data_ is a string or file-like object, it will be loaded with
517517
_json.loads_. Otherwise _data_ should be a JSON-like data structure and
518-
will be modified in-place.
518+
will be modified in place.
519519
520-
When modifying _data_ in-place, we return modified data too. This is
520+
When modifying _data_ in place, we return modified data too. This is
521521
to allow for replacing _data's_ root element, which is allowed by some
522522
patch operations.
523523

0 commit comments

Comments
 (0)