From 37fcb6b458e2b14c0eaf7b2bed9e7861dde540b0 Mon Sep 17 00:00:00 2001
From: AnnaXiong <anna_xiong@mckinsey.com>
Date: Thu, 11 Jan 2024 08:43:15 -0500
Subject: [PATCH] pr comments

---
 ...0110_093842_anna_xiong_add_max_retry_parameter.md |  3 +--
 vizro-ai/docs/pages/user_guides/run_vizro_ai.md      | 12 ++++--------
 vizro-ai/src/vizro_ai/_vizro_ai.py                   |  8 ++++----
 3 files changed, 9 insertions(+), 14 deletions(-)

diff --git a/vizro-ai/changelog.d/20240110_093842_anna_xiong_add_max_retry_parameter.md b/vizro-ai/changelog.d/20240110_093842_anna_xiong_add_max_retry_parameter.md
index 5cde76bd7..7a571f19b 100644
--- a/vizro-ai/changelog.d/20240110_093842_anna_xiong_add_max_retry_parameter.md
+++ b/vizro-ai/changelog.d/20240110_093842_anna_xiong_add_max_retry_parameter.md
@@ -16,12 +16,11 @@ Uncomment the section that is right (remove the HTML comment wrapper).
 - A bullet item for the Removed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
 
 -->
-<!--
+
 ### Added
 
 - - Added `max_debug_retry` parameter to `VizroAI.plot` to allow users to determine the maximum number of debugging attempts desired ([#261](https://github.com/mckinsey/vizro/pull/261))
 
--->
 <!--
 ### Changed
 
diff --git a/vizro-ai/docs/pages/user_guides/run_vizro_ai.md b/vizro-ai/docs/pages/user_guides/run_vizro_ai.md
index 1e15f9c4c..2d5bec551 100644
--- a/vizro-ai/docs/pages/user_guides/run_vizro_ai.md
+++ b/vizro-ai/docs/pages/user_guides/run_vizro_ai.md
@@ -82,16 +82,12 @@ The returned `code_string` can be used to dynamically render charts within your
 In case you would like to use the insights or code explanation, you can use `vizro_ai._run_plot_tasks(df, ..., explain=True)`, which returns a dictionary containing the code explanation and chart insights alongside the code.
 
 ### 4. `max_debug_retry` Parameter in plot Function
-Since the code is generated by Large Language Models (LLMs), it can contain bugs and thus fail on execution.
-When an error is encountered, an LLM-based debugging process will be triggered.
-The `max_debug_retry` parameter controls maximum number of retries the `plot` function attempts to debug errors.
-
-- **Default Value**: 3
-- **Type**: int
-- **Brief**: By default, the `max_debug_retry` is set to 3, the function will attempt to debug errors up to three times.
+- Default Value: 3
+- Type: int
+- Brief: By default, the `max_debug_retry` is set to 3, the function will attempt to debug errors up to three times.
 If the errors are not resolved after the maximum number of retries, the function will cease further debugging attempts.
 - **Example**:
-   Adjust the number of retries by setting `max_debug_retry` in the `plot` function.
+   E.g. if you would like adjust to 5 debugging attempts, you can set `max_debug_retry = 5` in the plot function:
     ```py
      vizro_ai.plot(df = df, user_input = "your user input", max_debug_retry= 5)
     ```
diff --git a/vizro-ai/src/vizro_ai/_vizro_ai.py b/vizro-ai/src/vizro_ai/_vizro_ai.py
index be71ab827..7dbdc62a6 100644
--- a/vizro-ai/src/vizro_ai/_vizro_ai.py
+++ b/vizro-ai/src/vizro_ai/_vizro_ai.py
@@ -109,10 +109,10 @@ def plot(
         """Plot visuals using vizro via english descriptions, english to chart translation.
 
         Args:
-            df: The dataframe to be analyzed
-            user_input: User questions or descriptions of the desired visual
-            explain: Flag to include explanation in response
-            max_debug_retry: Maximum number of retries to debug errors. Defaults to 3
+            df: The dataframe to be analyzed.
+            user_input: User questions or descriptions of the desired visual.
+            explain: Flag to include explanation in response.
+            max_debug_retry: Maximum number of retries to debug errors. Defaults to `3`.
         """
         output_dict = self._run_plot_tasks(df, user_input, explain=explain, max_debug_retry=max_debug_retry)
         code_string = output_dict.get("code_string")