Addressing PR comments

Author: adrianoaru-nhs

docs/InvestigationDatasetBuilderApplication.md

@@ -9,6 +9,7 @@ This application is a Streamlit-based tool for interactively building investigat
 - [Investigation Dataset Builder Application](#investigation-dataset-builder-application)
   - [Table of Contents](#table-of-contents)
   - [How to Use the Application](#how-to-use-the-application)
+    - [What this can be used for](#what-this-can-be-used-for)
     - [Pre-requisites](#pre-requisites)
     - [Launching the App](#launching-the-app)
     - [Selecting and Filling Sections](#selecting-and-filling-sections)
@@ -32,6 +33,14 @@ This application is a Streamlit-based tool for interactively building investigat
 
 ## How to Use the Application
 
+### What this can be used for
+
+This application can be used to create the necessary dictionaries in order to populate an investigation dataset<br>
+During the conversion on the automation tests from selenium to playwright it can be used for the following feature file steps (There are more but these are just examples):
+
+- And I add the following bowel preparation drugs and values within the Investigation Dataset for this subject:
+- And I set the following fields and values within the Investigation Dataset for this subject:
+
 ### Pre-requisites
 
 Before running the application, ensure you have the following:

pages/datasets/investigation_dataset_page.py

@@ -571,7 +571,7 @@ def is_edit_dataset_button_visible(self) -> bool:
         """
         return self.edit_dataset_button.is_visible()
 
-    def is_dataset_section_present(self, dataset_section_name: str) -> bool | None:
+    def is_dataset_section_present(self, dataset_section_name: str) -> Optional[bool]:
         """
         Checks if a section of the investigation dataset is present
         Args:
@@ -600,7 +600,7 @@ def is_dataset_section_present(self, dataset_section_name: str) -> bool | None:
         logging.info(f"Dataset section '{dataset_section_name}' not found.")
         return False
 
-    def get_dataset_section(self, dataset_section_name: str) -> Locator | None:
+    def get_dataset_section(self, dataset_section_name: str) -> Optional[Locator]:
         """
         Retrieves a dataset section by matching its header text.
         Only returns the locator if the section is visible.
@@ -609,7 +609,7 @@ def get_dataset_section(self, dataset_section_name: str) -> Locator | None:
         Args:
             dataset_section_name (str): The name of the dataset section to locate.
         Returns:
-            Locator | None: A Playwright Locator for the matching section if visible, or None if not found or not visible.
+            Optioanl[Locator]: A Playwright Locator for the matching section if visible, or None if not found or not visible.
         """
         logging.info(f"START: Looking for section '{dataset_section_name}'")
 
@@ -678,7 +678,7 @@ def is_dataset_section_on_page(
 
     def get_dataset_subsection(
         self, dataset_section_name: str, dataset_subsection_name: str
-    ) -> Locator | None:
+    ) -> Optional[Locator]:
         """
         Retrieves a specific subsection within a dataset section by matching the subsection's header text.
         The method first searches through elements with the `.DatasetSubSection` class.
@@ -687,7 +687,7 @@ def get_dataset_subsection(
             dataset_section_name (str): The name of the dataset section that contains the subsection.
             dataset_subsection_name (str): The name of the subsection to locate.
         Returns:
-            Locator | None: A Playwright Locator for the found subsection, or None if not found.
+            Optional[Locator]: A Playwright Locator for the found subsection, or None if not found.
         Raises:
             ValueError: If the specified dataset section cannot be found.
         """
@@ -735,17 +735,17 @@ def get_dataset_subsection(
     def are_fields_on_page(
         self,
         section_name: str,
-        subsection_name: str | None,
+        subsection_name: Optional[str],
         field_names: list[str],
-        visible: bool | None = None,
+        visible: Optional[bool] = None,
     ) -> bool:
         """
         Checks if the given fields are present in a section or subsection, with optional visibility checks.
         Args:
             section_name (str): The name of the dataset section.
-            subsection_name (str | None): The name of the subsection, if any.
+            subsection_name (Optional[str]): The name of the subsection, if any.
             field_names (list[str]): List of field labels to check.
-            visible (bool | None):
+            visible (Optional[bool]):
                 - True → fields must be visible
                 - False → fields must be not visible
                 - None → visibility doesn't matter (just check presence)