Add documentation

Author: aldro61

src/browsergym/workarena/tasks/dashboard.py

@@ -304,6 +304,7 @@ def setup_goal(self, page: playwright.sync_api.Page) -> Tuple[str | dict]:
             self.fixed_config if self.fixed_config else self.random.choice(self.all_configs())
         )
         # ... set start URL based on config
+        # ...... some of the reports have need a date filter to be applied so we do this by patching a placeholder in the URL
         self.start_url = self.instance.snow_url + self.config["url"]
 
         # Produce goal string based on question type
@@ -603,6 +604,8 @@ def _generate_random_config(
         """
         Generate a random configuration for the task
 
+        This can be used to regenerate configs that are valid under an updated date filter.
+
         Parameters:
         -----------
         page: playwright.sync_api.Page
@@ -674,6 +677,7 @@ def _generate_random_config(
 
             # On the fly generated report
             if not report.get("sys_id", None):
+                # ... these receive a filter that is added through the URL
                 url = f"/now/nav/ui/classic/params/target/sys_report_template.do%3Fsysparm_field%3D{report['field']}%26sysparm_type%3D{report['type']}%26sysparm_table%3D{report['table']}%26sysparm_from_list%3Dtrue%26sysparm_chart_size%3Dlarge%26sysparm_manual_labor%3Dtrue%26sysparm_query=sys_created_on<javascript:gs.dateGenerate('{REPORT_DATE_FILTER}','00:00:00')^EQ"
             # Report from the database
             else: