Skip to content

Commit 4b3a4bf

Browse files
committed
addressed sonarqube errors
1 parent bc4cbcd commit 4b3a4bf

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

docs/utility-guides/FitKitLogged.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,20 +26,26 @@ The methods in this utility require specific arguments. Below is a summary of th
2626

2727
The `fit_kit_logged` Utility includes methods for retrieving FIT test kits from the DB and splitting them into 'Normal' and 'Abnormal' results. Below are their key functions:
2828

29-
1. **`process_kit_data(smokescreen_properties: dict) -> list`**
30-
Retrieves the test data needed for compartment 3 and then splits it into two data frames, using the `split_fit_kits` method.
31-
- **Arguments**:
32-
- `smokescreen_properties` (dict): A dictionary containing properties required to retrieve and process kit data.
33-
- **Returns**: A list of tuples where each tuple contains a device ID (str) and a boolean flag (True for normal, False for abnormal).
34-
35-
2. **`split_fit_kits(kit_id_df: pd.DataFrame, smokescreen_properties: dict) -> pd.DataFrame`**
36-
This method splits the `dataframe` into two dataframes, 1 normal and 1 abnormal.
37-
- **Arguments**:
38-
- `kit_id_df` (pd.DataFrame): A `dataframe` containing fit kit IDs.
39-
- `smokescreen_properties` (dict): A dictionary containing the number of normal and abnormal fit kits to split.
40-
- **Returns**: A tuple containing two dataframes:
41-
- normal_fit_kit_df (pd.DataFrame): `dataframe` containing normal fit kits.
42-
- abnormal_fit_kit_df (pd.DataFrame): `dataframe` containing abnormal fit kits.
29+
1. **`process_kit_data(smokescreen_properties: dict) -> list`**
30+
Retrieves the test data needed for compartment 3 and then splits it into two data frames, using the `split_fit_kits` method.
31+
32+
- **Arguments**:
33+
- `smokescreen_properties` (dict): A dictionary containing properties required to retrieve and process kit data.
34+
35+
- **Returns**:
36+
A list of tuples where each tuple contains a device ID (str) and a `boolean` flag (True for normal, False for abnormal).
37+
38+
2. **`split_fit_kits(kit_id_df: pd.DataFrame, smokescreen_properties: dict) -> tuple`**
39+
This method splits the `dataframe` into two dataframes, one normal and one abnormal.
40+
41+
- **Arguments**:
42+
- `kit_id_df` (pd.DataFrame): A `dataframe` containing fit kit IDs.
43+
- `smokescreen_properties` (dict): A dictionary containing the number of normal and abnormal fit kits to split.
44+
45+
- **Returns**:
46+
A tuple containing two dataframes:
47+
- `normal_fit_kit_df` (pd.DataFrame): `dataframe` containing normal fit kits.
48+
- `abnormal_fit_kit_df` (pd.DataFrame): `dataframe` containing abnormal fit kits.
4349

4450
## Example Usage
4551

0 commit comments

Comments
 (0)