Skip to content

Commit 3f1a003

Browse files
committed
docs fix
1 parent 4c81d85 commit 3f1a003

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

REFERENCE.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ instance by default. collection.get() can override this behavior
214214
#### method `collection.get()`
215215

216216
```
217-
collection.get(root_obj: datapath.types.Collection, wrap: bool = False)
217+
collection.get(self, path: str, default: Any = NO_DEFAULT, wrap: bool = NO_DEFAULT) -> Any
218218
```
219219

220220
identical to get() for the wrapped root object
@@ -225,7 +225,7 @@ then the result will be wrapped in a new collection instance
225225
#### method `collection.iterate()`
226226

227227
```
228-
collection.iterate(root_obj: datapath.types.Collection, wrap: bool = False)
228+
collection.iterate(self, path: str, default: Any = NO_DEFAULT, wrap: bool = NO_DEFAULT) -> Generator[tuple[str, Any], NoneType, NoneType]
229229
```
230230

231231
identical to iterate() for the wrapped root object
@@ -236,31 +236,31 @@ then the yielded result will be wrapped in a new collection instance
236236
#### method `collection.put()`
237237

238238
```
239-
collection.put(root_obj: datapath.types.Collection, wrap: bool = False)
239+
collection.put(self, path: str, value: Any) -> None
240240
```
241241

242242
identical to put() for the wrapped root object
243243

244244
#### method `collection.delete()`
245245

246246
```
247-
collection.delete(root_obj: datapath.types.Collection, wrap: bool = False)
247+
collection.delete(self, path: str) -> None
248248
```
249249

250250
identical to delete() for the wrapped root object
251251

252252
#### method `collection.discard()`
253253

254254
```
255-
collection.discard(root_obj: datapath.types.Collection, wrap: bool = False)
255+
collection.discard(self, path: str) -> None
256256
```
257257

258258
identical to discard() for the wrapped root object
259259

260260
#### method `collection.fold()`
261261

262262
```
263-
collection.fold(root_obj: datapath.types.Collection, wrap: bool = False)
263+
collection.fold(self) -> dict
264264
```
265265

266266
convert the collection to a flat path dict using `fold_path_dict()`
@@ -277,7 +277,7 @@ Base class used to enable custom processing of the data structure during unfold
277277
#### method `UnfoldProcessor.process_list()`
278278

279279
```
280-
UnfoldProcessor.process_list()
280+
UnfoldProcessor.process_list(self, list_: list) -> Any
281281
```
282282

283283
called on a completed list; return value is inserted into the resulting data structure
@@ -286,7 +286,7 @@ instead of the original list
286286
#### method `UnfoldProcessor.process_dict()`
287287

288288
```
289-
UnfoldProcessor.process_dict()
289+
UnfoldProcessor.process_dict(self, dict_: datapath.types.Map) -> Any
290290
```
291291

292292
called on a completed dict; return value is inserted into the resulting data structure

docs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ def make_docs():
7575
descriptor = 'attribute'
7676
f.write(f'#### {descriptor} `{obj_name}.{attr_name}{suffix}`\n')
7777
if do_sig:
78-
f.write(f'\n```\n{obj_name}.{attr_name}{signature(obj)}\n```\n')
78+
f.write(f'\n```\n{obj_name}.{attr_name}{signature(attr)}\n```\n')
7979
write_doc(f, attr_doc, 2)
8080
f.write('\n')
8181
f.write('\n')

0 commit comments

Comments
 (0)