Updated docstrings

Author: Andyg79

pages/subject/subject_lynch_page.py

@@ -7,10 +7,14 @@ class SubjectPage(BasePage):
     """Page object for interacting with subject-related actions."""
 
     class StatusCodes:
+        """Status codes used in the screening status dropdown."""
+
         LYNCH_SELF_REFERRAL = "4005"
         SEEKING_FURTHER_DATA = "4007"
 
     class ReasonCodes:
+        """Reason codes used in the reason dropdown."""
+
         SELF_REFERRAL = "11316"
         UNCERTIFIED_DEATH = "11314"
         RESET_TO_SELF_REFERRAL = "11529"

utils/oracle/subject_selector.py

@@ -20,6 +20,12 @@ def get_subject_for_manual_cease(criteria: dict) -> str:
 
         Args:
             criteria (dict): Dictionary of filtering conditions to select a subject.
+                Example criteria:
+                    {
+                        "subject age": "75",
+                        "screening status": "Inactive",
+                        "subject hub code": "BCS02",
+                    }
 
         Returns:
             str: The NHS number of the selected subject.
@@ -63,6 +69,12 @@ def get_subject_for_pre_invitation(criteria: dict) -> str:
 
         Args:
             criteria (dict): Dictionary of filtering conditions to select a subject.
+                Example criteria:
+                    {
+                        "subject age": "75",
+                        "screening status": "Pre-invitation",
+                        "subject hub code": "BCS02",
+                    }
 
         Returns:
             str: The NHS number of the selected subject.
@@ -106,6 +118,14 @@ def get_or_create_subject_for_lynch_self_referral(
         Retrieves a subject NHS number suitable for Lynch self-referral scenarios.
         If no subject is found, creates one and returns its NHS number.
 
+        Internally uses the following selection criteria:
+            {
+                "subject age": "75",
+                "subject has lynch diagnosis": "Yes",
+                "screening status": "Lynch Self-referral",
+                "subject hub code": "BCS01"
+            }
+
         Args:
             screening_centre (str): Screening centre code for subject association.
             base_age (int): Minimum age to filter subject candidates.