Update compatibility.md: mention differing query parameter handling (#1262)

* Update compatibility.md

* Update docs/compatibility.md

* Update docs/compatibility.md

Co-authored-by: Florimond Manca <florimond.manca@gmail.com>
Co-authored-by: Tom Christie <tom@tomchristie.com>
Co-authored-by: Florimond Manca <florimond.manca@gmail.com>

diff --git a/docs/compatibility.md b/docs/compatibility.md
index daef4994a7b9970a32d295d21c878e4e349f1a6d..c52b887b2508134500f4d660eace82251f704705 100644 (file)
--- a/docs/compatibility.md
+++ b/docs/compatibility.md
@@ -1,6 +1,6 @@
 # Requests Compatibility Guide
 
-HTTPX aims to be compatible with the `requests` API wherever possible.
+HTTPX aims to be broadly compatible with the `requests` API.
 
 This documentation outlines places where the API differs...
 
@@ -89,3 +89,7 @@ If you need to mock HTTPX the same way that test utilities like `responses` and
 `requests` defers most of its HTTP networking code to the excellent [`urllib3` library](https://urllib3.readthedocs.io/en/latest/).
 
 On the other hand, HTTPX uses [HTTPCore](https://github.com/encode/httpcore) as its core HTTP networking layer, which is a different project than `urllib3`.
+
+## Query Parameters
+
+`requests` omits `params` whose values are `None` (e.g. `requests.get(..., params={"foo": None})`). This is not supported by HTTPX.