Add admonition about context managers in sdk.Client reference

Signed-off-by: Olivier Léobal <[email protected]>
Substra · Aug 16, 2023 · 1370803 · 1370803
1 parent 5a681b7
commit 1370803
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/substra/sdk/client.py b/substra/sdk/client.py
@@ -199,6 +199,12 @@ class Client:
             Defaults to None.
         username (str, optional): Username to authenticate to the Substra platform.
             Used in conjunction with a password to generate a token if not given, using the `login` function.
+
+            If using username/password, you should use a context manager to ensure the session is terminated:
+            ```
+            with Client(username, password) as client:
+               ...
+            ```
             Not stored.
             Defaults to None.
         password (str, optional): Password to authenticate to the Substra platform.