Skip to content

Commit 62dfda3

Browse files
As per PR # 83 comments, it is updated.
1 parent a4c1546 commit 62dfda3

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

docs/utility-guides/NHSNumberTools.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ common functionality that may apply to many services in relation to NHS Number m
99
- [Table of Contents](#table-of-contents)
1010
- [Using the NHS Number Tools class](#using-the-nhs-number-tools-class)
1111
- [`_nhs_number_checks()`: Checks if the NHS number is valid](#_nhs_number_checks-checks-if-the-nhs-number-is-valid)
12-
- [Example Usage for `_nhs_number_checks()`](#example-usage-for-_nhs_number_checks)
1312
- [Required Arguments](#required-arguments)
1413
- [Raises](#raises)
14+
- [Example Usage for `_nhs_number_checks()`](#example-usage-for-_nhs_number_checks)
1515
- [`spaced_nhs_number()`: Return Spaced NHS Number](#spaced_nhs_number-return-spaced-nhs-number)
16-
- [Example Usage for `spaced_nhs_number()`](#example-usage-for-spaced_nhs_number)
1716
- [Required Arguments](#required-arguments-1)
1817
- [Returns](#returns)
18+
- [Example Usage for `spaced_nhs_number()`](#example-usage-for-spaced_nhs_number)
1919

2020
## Using the NHS Number Tools class
2121

@@ -27,10 +27,6 @@ You can initialise the NHS Number Tools class by using the following code in you
2727

2828
The `_nhs_number_checks()` method does basic checks on NHS number value provided and raises an exception if the number is not valid:
2929

30-
## Example Usage for `_nhs_number_checks()`
31-
32-
from utils.nhs_number_tools import NHSNumberTools
33-
incorrect_nhs_no = "A23456789"
3430
NHSNumberTools._nhs_number_checks(incorrect_nhs_no)
3531

3632
### Required Arguments
@@ -45,14 +41,19 @@ The following are required for `_nhs_number_checks()`:
4541

4642
NHSNumberToolsException: If the NHS number is not numeric or not 10 digits long.
4743

44+
## Example Usage for `_nhs_number_checks()`
45+
46+
```python
47+
from utils.nhs_number_tools import NHSNumberTools
48+
incorrect_nhs_no = "A23456789"
49+
NHSNumberTools._nhs_number_checks(incorrect_nhs_no)
50+
```
51+
4852
## `spaced_nhs_number()`: Return Spaced NHS Number
4953

5054
The `spaced_nhs_number()` method is designed to take the provided NHS number and return it in a formatted
5155
string of the format `nnn nnn nnnn`. It's a static method so can be used in the following way:
5256

53-
## Example Usage for `spaced_nhs_number()`
54-
55-
# Return formatted NHS number
5657
spaced_nhs_number = NHSNumberTools.spaced_nhs_number("1234567890")
5758

5859
### Required Arguments
@@ -66,3 +67,11 @@ The following are required for `NHSNumberTools.spaced_nhs_number()`:
6667
### Returns
6768

6869
A `str` with the provided NHS number in `nnn nnn nnnn` format. For example, `NHSNumberTools.spaced_nhs_number(1234567890)` would return `123 456 7890`.
70+
71+
## Example Usage for `spaced_nhs_number()`
72+
73+
```python
74+
from utils.nhs_number_tools import NHSNumberTools
75+
# Return formatted NHS number
76+
spaced_nhs_number = NHSNumberTools.spaced_nhs_number("1234567890")
77+
```

0 commit comments

Comments
 (0)