Skip to content

Commit

Permalink
rewrite return section of docs for query api
Browse files Browse the repository at this point in the history
  • Loading branch information
JacksonChen666 committed Jan 31, 2025
1 parent 36a5766 commit 99f39c3
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions synadm/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -137,11 +137,10 @@ def query(
values) and passed to Python's str.format.
Returns:
string or None: Usually a JSON string containing
the response of the API; responses that are not 200(OK) (usally
error messages returned by the API) will also be returned as
JSON strings. On exceptions the error type and description are
logged and None is returned.
A dict, list or None. If it's a dict or list, it is a JSON
decoded response. Whether it is a dict or a list depends on what
the server responds with. It returns a None if any exceptions
are encountered.
"""
args = [urllib.parse.quote(arg, safe="") for arg in args]
kwargs = {k: urllib.parse.quote(v, safe="") for k, v in kwargs.items()}
Expand Down

0 comments on commit 99f39c3

Please sign in to comment.