Skip to content

Commit 4c9e26c

Browse files
miriamkwclaude
andcommitted
feat: production cleanup and finalize documentation
CI Configuration: - Restrict CI to only run on main branch pushes and PRs - Removes feature branch from triggers for production readiness Documentation Completion: - Add missing get_loop_recommendations() function documentation - Fix copy-paste error in add_insulin_on_board_to_df description - Correct return value description (iob column not ice column) - Preserve Windows build TODO comments for future reference All API functions now fully documented and CI properly configured. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent a2f2118 commit 4c9e26c

2 files changed

Lines changed: 15 additions & 3 deletions

File tree

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: CI Workflow
22

33
on:
44
push:
5-
branches: [main, feature/windows-linux-compability]
5+
branches: [main]
66
pull_request:
77
branches: [main]
88
types: [opened, synchronize, reopened]

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,18 @@ Fetches the active carbohydrates based on the provided JSON input.
139139
- **Returns**: The active carbohydrates as a double.
140140

141141

142+
-------------------------
143+
144+
### Get Loop Recommendations
145+
146+
`get_loop_recommendations(json_file)`
147+
148+
Uses the Loop algorithm to get comprehensive recommendations in JSON format.
149+
150+
- **Parameters**:
151+
- `json_file`: The JSON data input. See python tests and test files for example inputs.
152+
- **Returns**: A JSON string containing the complete Loop recommendations.
153+
142154
-------------------------
143155

144156
### Get Active Insulin
@@ -200,7 +212,7 @@ Adds an insulin counteraction effect column to the DataFrame input.
200212

201213
`add_insulin_on_board_to_df(df, basal, isf, cr, insulin_type='novolog', lookback=72)`
202214

203-
Adds an insulin counteraction effect column to the DataFrame input.
215+
Adds an insulin on board (IOB) column to the DataFrame input.
204216

205217
- **Parameters**:
206218
- `df`: The dataframe data input, with at least the columns basal, bolus and CGM, with datetime index.
@@ -209,7 +221,7 @@ Adds an insulin counteraction effect column to the DataFrame input.
209221
- `cr`: Carbohydrate ratio (grams per unit of insulin).
210222
- `insulin_type`: Type of insulin (default 'novolog').
211223
- `lookback`: Lookback to use for computing insulin on board (default 72).
212-
- **Returns**: The dataframe with an "ice" column.
224+
- **Returns**: The dataframe with an "iob" column.
213225

214226
-------------------------
215227

0 commit comments

Comments
 (0)