matrix-nio
matrix-nio copied to clipboard
[docs] `AsyncClient()`'s `ssl` has incomplete type hint and docstring
aiohttp.ClientSession.request() (docs) takes ssl: Union[None, bool, ssl.SSLContext, aiohttp.Fingerprint]. The current AsyncClient treats ssl as an opaque value to be forwarded to aiohttp.ClientSession.request() (in AsyncClient.send()). But AsyncClient's ssl parameter type hint and docs do not match aiohttp.
- The type hint should be complete (source link).
- The docstring should mention that
SSLContextallows for custom certificate validation (e.g. this is passed in by matrix-commander), andaiohttp.Fingerprintfor fingerprint validation (Readthedocs link).