diff options
| author | Elias Obeid <e.k.obeid@gmail.com> | 2018-04-26 16:02:43 +0200 |
|---|---|---|
| committer | Elias Obeid <ekobeid@gmail.com> | 2018-04-30 16:50:23 +0200 |
| commit | 75c57985b02b98c897994e81afcf88b69b33f528 (patch) | |
| tree | e8d48ac5a4b2dd86c355bb4c6afa11a182578983 | |
| parent | 11b82ca87c2a3d904ab86bc62e707cd00ead9cef (diff) | |
| download | python-requests-75c57985b02b98c897994e81afcf88b69b33f528.tar.gz | |
update json param's description to avoid confusion
- the Request class doesn't accept JSON, but a JSON serializable object
| -rw-r--r-- | requests/api.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/requests/api.py b/requests/api.py index bc2115c1..a2cc84d7 100644 --- a/requests/api.py +++ b/requests/api.py @@ -20,7 +20,7 @@ def request(method, url, **kwargs): :param url: URL for the new :class:`Request` object. :param params: (optional) Dictionary or bytes to be sent in the query string for the :class:`Request`. :param data: (optional) Dictionary or list of tuples ``[(key, value)]`` (will be form-encoded), bytes, or file-like object to send in the body of the :class:`Request`. - :param json: (optional) json data to send in the body of the :class:`Request`. + :param json: (optional) A JSON serializable Python object to send in the body of the :class:`Request`. :param headers: (optional) Dictionary of HTTP Headers to send with the :class:`Request`. :param cookies: (optional) Dict or CookieJar object to send with the :class:`Request`. :param files: (optional) Dictionary of ``'name': file-like-objects`` (or ``{'name': file-tuple}``) for multipart encoding upload. |