]> git.ipfire.org Git - thirdparty/httpx.git/commitdiff
Document compatibility difference for get, delete, head, and options (#418)
authorJt Miclat <jtmiclat@gmail.com>
Fri, 4 Oct 2019 00:46:24 +0000 (08:46 +0800)
committerSeth Michael Larson <sethmichaellarson@gmail.com>
Fri, 4 Oct 2019 00:46:24 +0000 (19:46 -0500)
docs/compatibility.md

index 9d8c864b2b31c7bd8c7755801a90d74123187541..d748ddd26d55924da692c8a16c8b82c864a96a41 100644 (file)
@@ -13,6 +13,7 @@ to the API in our own documentation. The following exceptions apply:
 * `httpx.codes` - In our documentation we prefer the uppercased versions, such as `codes.NOT_FOUND`,
 but also provide lower-cased versions for API compatibility with `requests`.
 * `stream=True`. - Streaming responses provide the `.stream()` and `.raw()` byte iterator interfaces, rather than the `.iter_content()` method and the `.raw` socket interface.
+* `.get`, `.delete`, `.head`, `.options` -  These methods do not support `files`, `data`, or `json` arguments. Use `.request` if you need to need to send data using these http methods.
 
 ## Advanced Usage