Skip to content

Commit 124eb76

Browse files
author
Artyom Nikitin
committed
doc: fix docstrings
1 parent bb4ea7b commit 124eb76

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

jsonpatch.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,9 @@ def apply_patch(doc, patch, in_place=False, pointer_cls=JsonPointer):
119119
By default patch will be applied to document copy.
120120
:type in_place: bool
121121
122+
:param pointer_cls: JSON pointer class to use.
123+
:type pointer_cls: Type[JsonPointer]
124+
122125
:return: Patched document object.
123126
:rtype: dict
124127
@@ -153,7 +156,7 @@ def make_patch(src, dst, pointer_cls=JsonPointer):
153156
:param dst: Data source document object.
154157
:type dst: dict
155158
156-
:param pointer_cls: JSON pointer (sub)class.
159+
:param pointer_cls: JSON pointer class to use.
157160
:type pointer_cls: Type[JsonPointer]
158161
159162
>>> src = {'foo': 'bar', 'numbers': [1, 3, 4, 8]}
@@ -256,7 +259,7 @@ def from_string(cls, patch_str, pointer_cls=JsonPointer):
256259
:param patch_str: JSON patch as raw string.
257260
:type pointer_cls: str
258261
259-
:param pointer_cls: JSON pointer (sub)class.
262+
:param pointer_cls: JSON pointer class to use.
260263
:type pointer_cls: Type[JsonPointer]
261264
262265
:return: :class:`JsonPatch` instance.
@@ -276,7 +279,7 @@ def from_diff(cls, src, dst, optimization=True, pointer_cls=JsonPointer):
276279
:param dst: Data source document object.
277280
:type dst: dict
278281
279-
:param pointer_cls: JSON pointer (sub)class.
282+
:param pointer_cls: JSON pointer class to use.
280283
:type pointer_cls: Type[JsonPointer]
281284
282285
:return: :class:`JsonPatch` instance.

0 commit comments

Comments
 (0)