Document that requests.session() is depreciated

Adds a docstring note that `requests.session()` is depreciated. Users should use `requests.Session()` in versions released after Requests v1.0.
DanielBorgesOliveira · Jun 21, 2018 · 1c13c5e · 1c13c5e
1 parent 883caaf
commit 1c13c5e
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/requests/sessions.py b/requests/sessions.py
@@ -735,7 +735,12 @@ def session():
     """
     Returns a :class:`Session` for context-management.
 
+    .. deprecated:: 1.0.0
+
+        This method has been deprecated since version 1.0.0 and is only kept for
+        backwards compatibility. New code should use :class:`~requests.sessions.Session`
+        to create a session. This may be removed at a future date.
+
     :rtype: Session
     """
-
     return Session()