diff options
| author | Artyom Nikitin <a.nikitin@edadeal.ru> | 2020-11-13 00:27:30 +0300 |
|---|---|---|
| committer | Artyom Nikitin <a.nikitin@edadeal.ru> | 2020-11-13 00:27:30 +0300 |
| commit | 124eb76c09136aef56618e7347230f981edd51c3 (patch) | |
| tree | a5dfaac11b73aa249248d0b8caff9bad93d6a6fb | |
| parent | bb4ea7ba669b26d29f31ec75015d92fb6633f07b (diff) | |
| download | python-json-patch-124eb76c09136aef56618e7347230f981edd51c3.tar.gz | |
doc: fix docstrings
| -rw-r--r-- | jsonpatch.py | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/jsonpatch.py b/jsonpatch.py index c893bea..92857ef 100644 --- a/jsonpatch.py +++ b/jsonpatch.py @@ -119,6 +119,9 @@ def apply_patch(doc, patch, in_place=False, pointer_cls=JsonPointer): By default patch will be applied to document copy. :type in_place: bool + :param pointer_cls: JSON pointer class to use. + :type pointer_cls: Type[JsonPointer] + :return: Patched document object. :rtype: dict @@ -153,7 +156,7 @@ def make_patch(src, dst, pointer_cls=JsonPointer): :param dst: Data source document object. :type dst: dict - :param pointer_cls: JSON pointer (sub)class. + :param pointer_cls: JSON pointer class to use. :type pointer_cls: Type[JsonPointer] >>> src = {'foo': 'bar', 'numbers': [1, 3, 4, 8]} @@ -256,7 +259,7 @@ class JsonPatch(object): :param patch_str: JSON patch as raw string. :type pointer_cls: str - :param pointer_cls: JSON pointer (sub)class. + :param pointer_cls: JSON pointer class to use. :type pointer_cls: Type[JsonPointer] :return: :class:`JsonPatch` instance. @@ -276,7 +279,7 @@ class JsonPatch(object): :param dst: Data source document object. :type dst: dict - :param pointer_cls: JSON pointer (sub)class. + :param pointer_cls: JSON pointer class to use. :type pointer_cls: Type[JsonPointer] :return: :class:`JsonPatch` instance. |