Skip to content

Commit 8024d4e

Browse files
committed
addressed sonaqube errors
1 parent 4b3a4bf commit 8024d4e

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

docs/utility-guides/FitKitLogged.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -27,25 +27,25 @@ The methods in this utility require specific arguments. Below is a summary of th
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

2929
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.
30+
Retrieves the test data needed for compartment 3 and then splits it into two data frames, using the `split_fit_kits` method.
3131

32-
- **Arguments**:
33-
- `smokescreen_properties` (dict): A dictionary containing properties required to retrieve and process kit data.
32+
- **Arguments**:
33+
- `smokescreen_properties` (dict): A dictionary containing properties required to retrieve and process kit data.
3434

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).
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).
3737

3838
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.
39+
This method splits the `dataframe` into two dataframes, one normal and one abnormal.
4040

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.
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.
4444

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.
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.
4949

5050
## Example Usage
5151

@@ -67,4 +67,4 @@ def example_usage() -> None:
6767
normal_flags.append(is_normal) # Store the flag (True for normal, False for abnormal).
6868

6969
example_usage()
70-
```
70+
```

0 commit comments

Comments
 (0)