Skip to content

Commit 3f17e3d

Browse files
committed
addressing sonarqube errors
1 parent 25b7ef5 commit 3f17e3d

File tree

1 file changed

+7
-30
lines changed

1 file changed

+7
-30
lines changed

docs/utility-guides/FitKitGeneration.md

Lines changed: 7 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ The fit_kit_generation Utility provides methods to generate and manage FIT test
99
- [Using the fit\_kit\_generation Utility](#using-the-fit_kit_generation-utility)
1010
- [Required Arguments](#required-arguments)
1111
- [fit\_kit\_generation Specific Functions](#fit_kit_generation-specific-functions)
12-
- [fit\_kit\_generation Specific Functions](#fit_kit_generation-specific-functions-1)
1312
- [Example Usage](#example-usage)
1413

1514
## Using the fit_kit_generation Utility
@@ -20,53 +19,31 @@ To use the fit_kit_generation Utility, import the `fit_kit_generation` module, f
2019

2120
The methods in this utility require specific arguments. Below is a summary of the required arguments for key methods:
2221
- `generate_kit`: Requires `batch_id` (int) and `kit_type` (str).
22+
2323
## fit_kit_generation Specific Functions
2424

2525
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

27-
1. **`create_fit_id_df(tk_type_id: int, hub_id: int, no_of_kits: int) -> DataFrame`**
28-
Creates a DataFrame containing FIT kit IDs based on the provided parameters.
27+
1. **`create_fit_id_df(tk_type_id: int, hub_id: int, no_of_kits: int) -> DataFrame`**
28+
Creates a DataFrame containing FIT kit IDs based on the provided parameters.
2929
- **Arguments**:
3030
- `tk_type_id` (int): The type ID of the test kit.
3131
- `hub_id` (int): The hub ID associated with the kits.
3232
- `no_of_kits` (int): The number of kits to retrieve.
3333
- **Returns**: A pandas DataFrame with the FIT kit IDs.
3434

35-
2. **`calculate_check_digit(kit_id: str) -> str`**
36-
Calculates and appends a check digit to the given kit ID.
35+
2. **`calculate_check_digit(kit_id: str) -> str`**
36+
Calculates and appends a check digit to the given kit ID.
3737
- **Arguments**:
3838
- `kit_id` (str): The kit ID to process.
3939
- **Returns**: The kit ID with the appended check digit.
4040

41-
3. **`convert_kit_id_to_fit_device_id(kit_id: str) -> str`**
42-
Converts a kit ID into a FIT Device ID.
41+
3. **`convert_kit_id_to_fit_device_id(kit_id: str) -> str`**
42+
Converts a kit ID into a FIT Device ID.
4343
- **Arguments**:
4444
- `kit_id` (str): The kit ID to convert.
4545
- **Returns**: The corresponding FIT Device ID.
4646

47-
## fit_kit_generation Specific Functions
48-
49-
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:
50-
51-
1. **`generate_kit(batch_id: int, kit_type: str) -> dict`**
52-
Generates a FIT test kit with the specified batch ID and kit type.
53-
- **Arguments**:
54-
- `batch_id` (int): The ID of the batch to which the kit belongs.
55-
- `kit_type` (str): The type of kit to generate (e.g., "Standard", "Advanced").
56-
- **Returns**: A dictionary containing the details of the generated kit.
57-
58-
2. **`validate_kit(kit_id: int) -> bool`**
59-
Validates a FIT test kit by its ID.
60-
- **Arguments**:
61-
- `kit_id` (int): The ID of the kit to validate.
62-
- **Returns**: `True` if the kit is valid, `False` otherwise.
63-
64-
3. **`manage_kits(action: str, kit_ids: list[int]) -> None`**
65-
Performs bulk actions on a list of FIT test kits.
66-
- **Arguments**:
67-
- `action` (str): The action to perform (e.g., "activate", "deactivate").
68-
- `kit_ids` (list[int]): A list of kit IDs to apply the action to.
69-
7047
## Example Usage
7148

7249
```python

0 commit comments

Comments
 (0)