Skip to content

Commit 592794e

Browse files
committed
Tweak docs
1 parent 57541b0 commit 592794e

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,4 +85,7 @@ profile_.py
8585

8686
# Test fixtures
8787
comparison_regression_suite.yaml
88-
cts.json
88+
cts.json
89+
90+
# System
91+
.DS_Store

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Python JSONPath
22

3-
JSONPath is a mini language for selecting objects from data formatted in JavaScript Object Notation, or equivalent Python objects, like dictionaries and lists.
3+
JSONPath is a mini language for selecting values from data formatted in JavaScript Object Notation, or equivalent Python objects, like dictionaries and lists.
44

55
Python JSONPath is a non-evaluating, read-only implementation of JSONPath, suitable for situations where JSONPath query authors are untrusted. We follow most of [RFC 9535](https://datatracker.ietf.org/doc/html/rfc9535). See [Notable differences](syntax.md#notable-differences) for a list of areas where we deviate from the standard.
66

jsonpath/fluent_api.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
"""A fluent API for managing JSONPathMatch iterators."""
2+
23
from __future__ import annotations
34

45
import collections
@@ -118,7 +119,7 @@ def locations(self) -> Iterable[str]:
118119
return (m.path for m in self._it)
119120

120121
def items(self) -> Iterable[Tuple[str, object]]:
121-
"""Return an iterable of (object, path) tuples, one for each match."""
122+
"""Return an iterable of (path, object) tuples, one for each match."""
122123
return ((m.path, m.obj) for m in self._it)
123124

124125
def pointers(self) -> Iterable[JSONPointer]:

0 commit comments

Comments
 (0)