@@ -19,7 +19,7 @@ def request(method, url, **kwargs):
1919 :param method: method for the new :class:`Request` object.
2020 :param url: URL for the new :class:`Request` object.
2121 :param params: (optional) Dictionary or bytes to be sent in the query string for the :class:`Request`.
22- :param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`.
22+ :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`.
2323 :param json: (optional) json data to send in the body of the :class:`Request`.
2424 :param headers: (optional) Dictionary of HTTP Headers to send with the :class:`Request`.
2525 :param cookies: (optional) Dict or CookieJar object to send with the :class:`Request`.
@@ -29,14 +29,16 @@ def request(method, url, **kwargs):
2929 defining the content type of the given file and ``custom_headers`` a dict-like object containing additional headers
3030 to add for the file.
3131 :param auth: (optional) Auth tuple to enable Basic/Digest/Custom HTTP Auth.
32- :param timeout: (optional) How long to wait for the server to send data
32+ :param timeout: (optional) How many seconds to wait for the server to send data
3333 before giving up, as a float, or a :ref:`(connect timeout, read
3434 timeout) <timeouts>` tuple.
3535 :type timeout: float or tuple
3636 :param allow_redirects: (optional) Boolean. Enable/disable GET/OPTIONS/POST/PUT/PATCH/DELETE/HEAD redirection. Defaults to ``True``.
3737 :type allow_redirects: bool
3838 :param proxies: (optional) Dictionary mapping protocol to the URL of the proxy.
39- :param verify: (optional) whether the SSL cert will be verified. A CA_BUNDLE path can also be provided. Defaults to ``True``.
39+ :param verify: (optional) Either a boolean, in which case it controls whether we verify
40+ the server's TLS certificate, or a string, in which case it must be a path
41+ to a CA bundle to use. Defaults to ``True``.
4042 :param stream: (optional) if ``False``, the response content will be immediately downloaded.
4143 :param cert: (optional) if String, path to ssl client cert file (.pem). If Tuple, ('cert', 'key') pair.
4244 :return: :class:`Response <Response>` object
@@ -57,7 +59,7 @@ def request(method, url, **kwargs):
5759
5860
5961def get (url , params = None , ** kwargs ):
60- """Sends a GET request.
62+ r """Sends a GET request.
6163
6264 :param url: URL for the new :class:`Request` object.
6365 :param params: (optional) Dictionary or bytes to be sent in the query string for the :class:`Request`.
@@ -71,7 +73,7 @@ def get(url, params=None, **kwargs):
7173
7274
7375def options (url , ** kwargs ):
74- """Sends a OPTIONS request.
76+ r """Sends a OPTIONS request.
7577
7678 :param url: URL for the new :class:`Request` object.
7779 :param \*\*kwargs: Optional arguments that ``request`` takes.
@@ -84,7 +86,7 @@ def options(url, **kwargs):
8486
8587
8688def head (url , ** kwargs ):
87- """Sends a HEAD request.
89+ r """Sends a HEAD request.
8890
8991 :param url: URL for the new :class:`Request` object.
9092 :param \*\*kwargs: Optional arguments that ``request`` takes.
@@ -97,10 +99,10 @@ def head(url, **kwargs):
9799
98100
99101def post (url , data = None , json = None , ** kwargs ):
100- """Sends a POST request.
102+ r """Sends a POST request.
101103
102104 :param url: URL for the new :class:`Request` object.
103- :param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`.
105+ :param data: (optional) Dictionary (will be form-encoded) , bytes, or file-like object to send in the body of the :class:`Request`.
104106 :param json: (optional) json data to send in the body of the :class:`Request`.
105107 :param \*\*kwargs: Optional arguments that ``request`` takes.
106108 :return: :class:`Response <Response>` object
@@ -111,10 +113,10 @@ def post(url, data=None, json=None, **kwargs):
111113
112114
113115def put (url , data = None , ** kwargs ):
114- """Sends a PUT request.
116+ r """Sends a PUT request.
115117
116118 :param url: URL for the new :class:`Request` object.
117- :param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`.
119+ :param data: (optional) Dictionary (will be form-encoded) , bytes, or file-like object to send in the body of the :class:`Request`.
118120 :param json: (optional) json data to send in the body of the :class:`Request`.
119121 :param \*\*kwargs: Optional arguments that ``request`` takes.
120122 :return: :class:`Response <Response>` object
@@ -125,10 +127,10 @@ def put(url, data=None, **kwargs):
125127
126128
127129def patch (url , data = None , ** kwargs ):
128- """Sends a PATCH request.
130+ r """Sends a PATCH request.
129131
130132 :param url: URL for the new :class:`Request` object.
131- :param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`.
133+ :param data: (optional) Dictionary (will be form-encoded) , bytes, or file-like object to send in the body of the :class:`Request`.
132134 :param json: (optional) json data to send in the body of the :class:`Request`.
133135 :param \*\*kwargs: Optional arguments that ``request`` takes.
134136 :return: :class:`Response <Response>` object
@@ -139,7 +141,7 @@ def patch(url, data=None, **kwargs):
139141
140142
141143def delete (url , ** kwargs ):
142- """Sends a DELETE request.
144+ r """Sends a DELETE request.
143145
144146 :param url: URL for the new :class:`Request` object.
145147 :param \*\*kwargs: Optional arguments that ``request`` takes.
0 commit comments