Repository navigation
docs: refresh README for current main - #92
Merged
Merged
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideRefreshes the README to accurately describe the currently implemented clinical training-load behavior, without introducing claims about unreleased features. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Note Currently processing new changes in this PR. This may take a few minutes, please wait... ⚙️ Run configuration
📒 Files selected for processing (1)
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configuration
📒 Files selected for processing (1)
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe README now states that Banister/Edwards TRIMP and CTL/ATL/TSB strain scores use the user’s quiet-waking heart-rate level as their reference. ChangesTraining Load Documentation
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~3 minutes Change: Other Merge Risk: ⚪ Minimal · up to The README accurately scopes the quiet-waking reference to strain. No material issue remains, so the PR is ready to merge subject to normal checks. Pre-merge checks |
 |
| Check name | Status | Explanation |
|---|---|---|
| Description Check |  |
Check skipped - CodeRabbit’s high-level summary is enabled. |
| Title check | |
The title clearly identifies the documentation change and states that the README was refreshed for the current main branch. |
| Docstring Coverage | |
No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0… |
| Linked Issues check | |
Check skipped because no linked issues were found for this pull request. |
| Out of Scope Changes check | |
Check skipped because no linked issues were found for this pull request. |
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 1 issue
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="README.md" line_range="98-99" />
<code_context>
LF/HF), PRSA (deceleration/acceleration capacity), nocturnal RHR/dip, an illness-risk
CUSUM state machine, Plews ln-RMSSD readiness, Baevsky stress index, Banister/Edwards
- TRIMP + CTL/ATL/TSB training load, a Poincaré irregular-rhythm screen, cosinor circadian
+ TRIMP + CTL/ATL/TSB training load (strain is scored above the user's own quiet waking
+ heart-rate level, not a fixed population reference), a Poincaré irregular-rhythm screen, cosinor circadian
fitting, and real-time cardiac coherence for guided breathing sessions.
- **`sleep/`** — van Hees z-angle segmentation feeding a cardiac/motion stager (the
</code_context>
<issue_to_address>
**Strain scores imply a personal baseline**
When a caller uses the public `trimpStrain` API, `trimpStrain` maps raw Banister TRIMP directly to 0–100 without a quiet-waking baseline, so ordinary waking is counted as strain despite the README’s claim that strain is scored above the user’s baseline.
Clarify that the baseline adjustment does not apply to `trimpStrain`.
</issue_to_address>Sourcery assessment
Approval pending. 1 finding to address first.
Blocking findings: README.md:99
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refreshes the README to match what is on main today (no unreleased features claimed).
Prepared for owner review; not merged.
🤖 Generated with Claude Code
Summary by Sourcery
Update the README to match the current main branch without documenting unreleased functionality.
Enhancements:
Documentation:
Summary by CodeRabbit