Base url docs (#7448)

Add information to behavior of ClientSession's base_url parameter.
aio-libs · Jul 28, 2023 · 38ffe6f · 38ffe6f
1 parent dc17263
commit 38ffe6f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/CHANGES/6647.doc b/CHANGES/6647.doc
@@ -0,0 +1 @@
+Added information on behavior of base_url parameter in `ClientSession`.
diff --git a/docs/client_reference.rst b/docs/client_reference.rst
@@ -57,7 +57,9 @@ The client session supports the context manager protocol for self closing.
 
 
    :param base_url: Base part of the URL (optional)
-      If set it allows to skip the base part in request calls.
+      If set, it allows to skip the base part (https://docs.aiohttp.org) in
+      request calls. If base_url includes a path (as in
+      https://docs.aiohttp.org/en/stable) the path is ignored/discarded.
 
       .. versionadded:: 3.8