Skip to content

Commit 07425f2

Browse files
committed
Addressed sonarqube errors
1 parent 3f17e3d commit 07425f2

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/utility-guides/FitKitGeneration.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
# Utility Guide: fit_kit_generation
1+
# Utility Guide: Fit Kit Generation
22

3-
The fit_kit_generation Utility provides methods to generate and manage FIT test kits for testing purposes.
3+
The Fit Kit Generation Utility provides methods to generate and manage FIT test kits for testing purposes.
44

55
## Table of Contents
66

7-
- [Utility Guide: fit\_kit\_generation](#utility-guide-fit_kit_generation)
7+
- [Utility Guide: Fit Kit Generation](#utility-guide-fit-kit-generation)
88
- [Table of Contents](#table-of-contents)
9-
- [Using the fit\_kit\_generation Utility](#using-the-fit_kit_generation-utility)
9+
- [Using the Fit Kit Generation Utility](#using-the-fit-kit-generation-utility)
1010
- [Required Arguments](#required-arguments)
11-
- [fit\_kit\_generation Specific Functions](#fit_kit_generation-specific-functions)
11+
- [Fit Kit Generation Specific Functions](#fit-kit-generation-specific-functions)
1212
- [Example Usage](#example-usage)
1313

14-
## Using the fit_kit_generation Utility
14+
## 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.
1717

1818
## Required Arguments
1919

2020
The methods in this utility require specific arguments. Below is a summary of the required arguments for key methods:
2121
- `generate_kit`: Requires `batch_id` (int) and `kit_type` (str).
2222

23-
## fit_kit_generation Specific Functions
23+
## Fit Kit Generation Specific Functions
2424

25-
The fit_kit_generation Utility includes methods for generating, validating, and managing FIT test kits. These methods are designed to streamline the process of creating test kits for various scenarios. Below are some key functions:
25+
The Fit Kit Generation Utility includes methods for generating, validating, and managing FIT test kits. These methods are designed to streamline the process of creating test kits for various scenarios. Below are some key functions:
2626

2727
1. **`create_fit_id_df(tk_type_id: int, hub_id: int, no_of_kits: int) -> DataFrame`**
2828
Creates a DataFrame containing FIT kit IDs based on the provided parameters.

0 commit comments

Comments
 (0)