From b2864bab0403b2623485fbb7c1233216934f8751 Mon Sep 17 00:00:00 2001 From: RGBCube <78925721+RGBCube@users.noreply.github.com> Date: Fri, 21 Jan 2022 15:26:21 +0300 Subject: [PATCH] docs --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2c275ec..d7c4046 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,15 @@ if the `pathmagic` kwarg is given, it will spit it by the `+`'s and make dicts(o ## `db.get(key: str, *, default=None, pathmagic="")` Returns the value of the key in the json, if the key isn't set in the json, it returns the default kwarg. -if the `pathmagic` kwarg is given, it will spit it by the `+`'s and follow the path in it in the JSON data, will return the `default` kwarg if the path is empty or has a value that isnt a dict. +if the `pathmagic` kwarg is given, it will spit it by the `+`'s and follow the path in it in the JSON data, it will return the `default` kwarg if the path is empty or has a value that isnt a dict. ## `db.all()` Returns all the JSON data. -## `db.rem(key: str)` +## `db.rem(key: str, *, pathmagic="")` Removes the key and value pair from the JSON. Note that this will not do anything if the key isn't set in the JSON. + +if the `pathmagic` kwarg is given, it will spit it by the `+`'s and follow the path in it in the JSON data, then it will remove the key and value pair. ## `db.nuke()` Deletes everything in the JSON.