Skip to content

Commit

Permalink
Fix query function docstring (arguments only)
Browse files Browse the repository at this point in the history
- Add missing arguments.
- Remove (types) since we have type hints now.
- Reword here and there.
  • Loading branch information
JOJ0 committed Jan 24, 2025
1 parent b5eef4a commit de434cc
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions synadm/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,19 +103,19 @@ def query(
Handles requests methods, logging and exceptions, and URL encoding.
Args:
urlpart (string): The path to the API endpoint, excluding
self.base_url and self.path (the part after
proto://fqdn:port/path). It will be passed to Python's
str.format, so the string should not be already formatted
(as f-strings or with str.format) as to sanitize the URL.
params (dict, optional): URL parameters (?param1&paarm2). Defaults
to None.
data (dict, optional): Request body used in POST, PUT, DELETE
requests. Defaults to None.
base_url_override (bool): The default setting of self.base_url set
method: The http method to use (get, post, put, ...)
urlpart: The path to the API endpoint, excluding self.base_url and
self.path (the part after proto://fqdn:port/path). It will be
passed to Python's str.format, so the string should not be
already formatted (as f-strings or with str.format) as to
sanitize the URL.
params: URL parameters (?param1&paarm2)..
data: Request body used in POST, PUT, DELETE requests.
token: An optional token overriding the configured one.
base_url_override: The default setting of self.base_url set
on initialization can be overwritten using this argument.
verify(bool): Mandatory SSL verification is turned on by default
and can be turned off using this method.
verify: Mandatory SSL verification is on by default and can be
turned off using this method.
*args: Arguments that will be URL encoded and passed to Python's
str.format.
**kwargs: Keyword arguments that will be URL encoded (only the
Expand Down

0 comments on commit de434cc

Please sign in to comment.