Skip to content

Commit f5d651f

Browse files
committed
docs
1 parent da2a42f commit f5d651f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ from jsonparse import find_key, find_keys, find_key_chain, find_key_value, find_
129129

130130
### find_key
131131
<pre>
132-
<b>find_key(</b><i>data</i>: dict | list, <i>key</i>: str<b>)</b> -> list
132+
<b>find_key(</b><i>data</i>: dict | list | OrderedDict, <i>key</i>: str<b>)</b> -> list
133133
</pre>
134134

135135
&nbsp;&nbsp;&nbsp;&nbsp;Will return all values of the matched key.
@@ -146,7 +146,7 @@ find_key(data, 'key')
146146

147147
### find_keys
148148
<pre>
149-
<b>find_keys(</b><i>data</i>: dict | list, <i>keys</i>: list, <i>group</i>: bool = True<b>)</b> -> list
149+
<b>find_keys(</b><i>data</i>: dict | list | OrderedDict, <i>keys</i>: list, <i>group</i>: bool = True<b>)</b> -> list
150150
</pre>
151151

152152
&nbsp;&nbsp;&nbsp;&nbsp;The default return value is a two dimensional list. `[ [], [], ...]`.
@@ -167,7 +167,7 @@ find_keys(data, ['rope', 'cable'], group=False)
167167

168168
### find_key_chain
169169
<pre>
170-
<b>find_key_chain(</b><i>data</i>: dict | list, <i>keys</i>: list<b>)</b> -> list
170+
<b>find_key_chain(</b><i>data</i>: dict | list | OrderedDict, <i>keys</i>: list<b>)</b> -> list
171171
</pre>
172172

173173
&nbsp;&nbsp;&nbsp;&nbsp;The key chain is an ordered list of keys. The chain needs to start at the root level of the nested data.
@@ -192,7 +192,7 @@ find_key_chain(data, ['*', 'key', '*'])
192192

193193
### find_key_value
194194
<pre>
195-
<b>find_key_value(</b><i>data</i>: dict | list, <i>key</i>: str, <i>value</i>: str | int | float | bool | None) -> list
195+
<b>find_key_value(</b><i>data</i>: dict | list | OrderedDict, <i>key</i>: str, <i>value</i>: str | int | float | bool | None) -> list
196196
</pre>
197197

198198
&nbsp;&nbsp;&nbsp;&nbsp;The returned list contains the dictionaries that contain the specified key:value pair.
@@ -209,7 +209,7 @@ find_key_value(data, 'chain', 'B')
209209

210210
### find_value
211211
<pre>
212-
<b>find_value(</b><i>data</i>: dict | list, <i>value</i>: str | int | float | bool | None<b>)</b> -> list
212+
<b>find_value(</b><i>data</i>: dict | list | OrderedDict, <i>value</i>: str | int | float | bool | None<b>)</b> -> list
213213
</pre>
214214

215215
&nbsp;&nbsp;&nbsp;&nbsp;Will return all keys of the matched value.

0 commit comments

Comments
 (0)