encode/httpx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document compatibility difference for get, delete, head, and options (#418)

Browse Source
This commit is contained in:
Jt Miclat 2019-10-04 08:46:24 +08:00 committed by Seth Michael Larson
parent 9e1cc26f8a
commit 85fa89c49c
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/compatibility.md
View 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