As per Jira Ticket, https://nhsd-jira.digital.nhs.uk/browse/BCSS-20629 - BCSS – Playwright - NHS Number Tools Markdown Improvements - Utility Guide - NHSNumberTools.md is updated & also Doc String is updated for nhs_number_tools.py

Author: vidhya-chandra1

docs/utility-guides/NHSNumberTools.md

@@ -8,8 +8,11 @@ common functionality that may apply to many services in relation to NHS Number m
 - [Utility Guide: NHS Number Tools](#utility-guide-nhs-number-tools)
   - [Table of Contents](#table-of-contents)
   - [Using the NHS Number Tools class](#using-the-nhs-number-tools-class)
-  - [`spaced_nhs_number()`: Return Spaced NHS Number](#spaced_nhs_number-return-spaced-nhs-number)
+  - [`_nhs_number_checks()`: If the input is not numeric or not 10 digits, it raises a NHSNumberToolsException()](#_nhs_number_checks-if-the-input-is-not-numeric-or-not-10-digits-it-raises-a-nhsnumbertoolsexception)
     - [Required Arguments](#required-arguments)
+    - [Raises](#raises)
+  - [`spaced_nhs_number()`: Return Spaced NHS Number](#spaced_nhs_number-return-spaced-nhs-number)
+    - [Required Arguments](#required-arguments-1)
     - [Returns](#returns)
 
 ## Using the NHS Number Tools class
@@ -18,6 +21,32 @@ You can initialise the NHS Number Tools class by using the following code in you
 
     from utils.nhs_number_tools import NHSNumberTools
 
+## `_nhs_number_checks()`: If the input is not numeric or not 10 digits, it raises a NHSNumberToolsException()
+
+The `_nhs_number_checks()` method does basic checks on NHS number values provided and raises an exception if the number is not valid:
+
+    # Args nhs_number (str): The NHS number to check
+    if not nhs_number.isnumeric():
+            raise NHSNumberToolsException(
+                "The NHS number provided ({}) is not numeric.".format(nhs_number)
+            )
+        if len(nhs_number) != 10:
+            raise NHSNumberToolsException(
+                "The NHS number provided ({}) is not 10 digits.".format(nhs_number)
+            )
+
+### Required Arguments
+
+The following are required for `_nhs_number_checks()`:
+
+| Argument   | Format         | Description               |
+| -----------| -------------- | ------------------------- |
+| nhs_number | `str`          | The NHS number to check   |
+
+### Raises
+
+NHSNumberToolsException: If the NHS number is not numeric or not 10 digits long.
+
 ## `spaced_nhs_number()`: Return Spaced NHS Number
 
 The `spaced_nhs_number()` method is designed to take the provided NHS number and return it in a formatted

utils/nhs_number_tools.py

@@ -11,10 +11,16 @@ class NHSNumberTools:
     @staticmethod
     def _nhs_number_checks(nhs_number: str) -> None:
         """
-        This does basic checks on NHS number values provided and raises an exception if the number is not valid.
+        This will validate that the provided NHS number is numeric and exactly 10 digits long.
 
         Args:
-            nhs_number (str): The NHS number to check.
+            nhs_number (str): The NHS number to validate.
+
+        Raises:
+            NHSNumberToolsException: If the NHS number is not numeric or not 10 digits long.
+
+        Returns:
+            None
         """
         if not nhs_number.isnumeric():
             raise NHSNumberToolsException(