diff --git a/docs/usage.md b/docs/usage.md index 9565422..078b30b 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -54,6 +54,10 @@ True ### `generate()` +Returns a list of 1 or more valid NHS numbers generated randomly. + +By default numbers will be generated from any valid range, including ranges allocated for live patient use. + ```python >>> import nhs_number @@ -72,6 +76,9 @@ True ['7709030025'] ``` +!!! warning "Working with synethetic / unallocated numbers only" + If you want to avoid generating numbers which may have been allocated to real patients, apply the `for_region=REGION_SYNTHETIC` parameter to constrain the output of the function to only numbers from the 900000000n - 999999999n testing range. + ### Regions You can obtain Region objects via the package's `REGION_*` constants: