Skip to content

Commit ebc59c6

Browse files
committed
Addressed PR comments
1 parent e1715d7 commit ebc59c6

File tree

1 file changed

+6
-11
lines changed

1 file changed

+6
-11
lines changed

docs/utility-guides/FitKitGeneration.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The Fit Kit Generation Utility provides methods to generate and manage FIT test
1313

1414
## Using the Fit Kit Generation Utility
1515

16-
To use the Fit Kit Generation Utility, import the `fit_kit_generation` module, from the `utils` directory, into your test file and call its methods from within your tests, as required.
16+
To use the Fit Kit Generation Utility, import the `fit_kit_generation` module, from the `utils` directory, into your test file and call its methods from within your tests, as required. To generate the fit kit IDs, the only method required is create_fit_id_df. This will return a dataframe with all the transformations already taking place.
1717

1818
## Required Arguments
1919

@@ -56,18 +56,13 @@ def example_usage() -> None:
5656
hub_id = 101
5757
no_of_kits_to_retrieve = 2
5858

59-
# Step 1: Retrieve and process FIT kit data
59+
# Calling the fit_kit_df method will do the following:
60+
# Step 1: Retrieve and process FIT kit data
61+
# Step 2: Calculate a check digit for a single kit ID
62+
# Step 3: Convert a kit ID to a FIT Device ID
63+
6064
fit_kit_df = create_fit_id_df(tk_type_id, hub_id, no_of_kits_to_retrieve)
6165
print("Processed FIT Kit DataFrame:")
6266
print(fit_kit_df)
6367

64-
# Step 2: Calculate a check digit for a single kit ID
65-
kit_id = "ABC123"
66-
kit_with_check_digit = calculate_check_digit(kit_id)
67-
print(f"Kit ID with Check Digit: {kit_with_check_digit}")
68-
69-
# Step 3: Convert a kit ID to a FIT Device ID
70-
fit_device_id = convert_kit_id_to_fit_device_id(kit_with_check_digit)
71-
print(f"FIT Device ID: {fit_device_id}")
72-
7368
example_usage()

0 commit comments

Comments
 (0)