From bba67257cdd2124169b12692e4c51cb146d94df7 Mon Sep 17 00:00:00 2001
From: richard-rogers <93153899+richard-rogers@users.noreply.github.com>
Date: Wed, 2 Oct 2024 17:57:30 +0100
Subject: [PATCH] update docstring for upload_on_log (#1573)

## Description

Updates `init()` docstring to describe `upload_on_log`

## Related

Relates to whylabs/whylogs#1570


- [ ] I have reviewed the [Guidelines for Contributing](CONTRIBUTING.md)
and the [Code of Conduct](CODE_OF_CONDUCT.md).
---
 python/whylogs/api/whylabs/session/session_manager.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/python/whylogs/api/whylabs/session/session_manager.py b/python/whylogs/api/whylabs/session/session_manager.py
index 52816dac1..886c78425 100644
--- a/python/whylogs/api/whylabs/session/session_manager.py
+++ b/python/whylogs/api/whylabs/session/session_manager.py
@@ -95,7 +95,8 @@ def init(
         default_dataset_id: The default dataset id to use for uploading profiles. This is only used if the session is authenticated.
             This is a convenience argument so that you don't have to supply the dataset id every time you upload a profile if
             you're only using a single dataset id.
-
+        upload_on_log: If True, and the session type is WHYLOGS or WHYLOGS_ANONYMOUS, automaticall upload the profile to WhyLabs
+            from the why.log() function. By default, uploading to WhyLabs requires an explicit write() call from a WhyLabsWriter.
     """
     if reinit:
         SessionManager.reset()