comments: wire facts only

[abdulsaheel]

rewords the alarm, r22, opcode-safety and gen5 record comments so they just state the byte layout and what was verified on hw, not where it came from. comments and test names only, no code changes.

labrador.dart / control.dart hello docs left alone, #74 already covers those.

Summary by Sourcery

Clarify protocol and hardware-verification comments by focusing on byte layouts and observed facts rather than their provenance.

Enhancements:

• Reword comments and test names to describe verified byte layouts, observed behavior, and unresolved semantics without attributing findings to external reference implementations.

Tests:

• Update test descriptions and comments to use source-neutral terminology while preserving the existing wire-vector and historical-layout coverage.

Summary by CodeRabbit

• Documentation
  • Updated comments and descriptions to clarify the evidence and scope behind device markers, alarm guidance, command classifications, and historical record interpretations.
  • Removed or narrowed references to external implementations and sources.
• Tests
  • Revised test names and fixture notes to describe observed hardware behavior more precisely. Test behavior and assertions are unchanged.

[sourcery-ai]

Sorry @abdulsaheel, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 5 days and 14 hours by commenting @sourcery-ai review. Upgrade to get a review now.

[sourcery-ai]

Reviewer's Guide

This comments-only PR removes provenance claims about upstream repositories and the official app, replacing them with concise descriptions of wire layouts, observed hardware verification, and remaining uncertainty; test names and comments are updated consistently, with no runtime code changes.

File-Level Changes

Change	Details	Files
Reworded implementation and protocol comments to describe observable byte layouts, hardware verification, and behavior without attributing facts to external reference projects or official app captures.	Removed upstream/reference-repository and official-app provenance from alarm, R22, opcode-safety, and gen5 record documentation. Retained byte offsets, payload shapes, verified firmware/fixture evidence, safety caveats, and unresolved semantic notes. Adjusted wording around gen5 record versions, decoder shape checks, and field interpretations to remain evidence-based.	lib/src/band.dart lib/src/commands.dart lib/src/constants.dart lib/src/gen5_records.dart lib/src/records.dart
Updated test comments and names to remove external-source attribution while preserving the tested facts and fixture context.	Renamed tests describing official captures or reference-repository agreement. Simplified fixture and field-analysis comments to state the wire vector, offsets, and observed behavior directly.	test/gen5_command_surface_test.dart test/gen5_historical_test.dart test/gen5_test.dart

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 22 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

• Configuration used: Organization UI
• Review profile: ASSERTIVE
• Plan: Advanced
• Run ID: 7d874cc3-7702-4790-aefe-26cc21e88912

📥 Commits

Reviewing files that changed from the base of the PR and between fb1b431 and b7fd7d2.

📒 Files selected for processing (8)

• lib/src/band.dart
• lib/src/commands.dart
• lib/src/constants.dart
• lib/src/gen5_records.dart
• lib/src/records.dart
• test/gen5_command_surface_test.dart
• test/gen5_historical_test.dart
• test/gen5_test.dart

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: Organization UI
• Review profile: ASSERTIVE
• Plan: Advanced
• Run ID: d6ca7dd3-3568-401f-ad3a-9d703575f8e1

📥 Commits

Reviewing files that changed from the base of the PR and between bc7d8d0 and fb1b431.

📒 Files selected for processing (8)

• lib/src/band.dart
• lib/src/commands.dart
• lib/src/constants.dart
• lib/src/gen5_records.dart
• lib/src/records.dart
• test/gen5_command_surface_test.dart
• test/gen5_historical_test.dart
• test/gen5_test.dart

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

This change revises comments and test descriptions about alarm forms, command values, opcode classifications, and gen5 record evidence. It does not change runtime behavior or test assertions.

Changes

Protocol documentation claims

Layer / File(s)	Summary
Alarm and command-surface wording lib/src/commands.dart, test/gen5_command_surface_test.dart	Alarm and command comments remove or narrow claims about official-app behavior and reference implementations. The alarm wire-vector test description now identifies a real WHOOP 4.0 arm.
Protocol evidence and attribution wording lib/src/band.dart, lib/src/constants.dart, lib/src/gen5_records.dart, lib/src/records.dart, test/gen5_historical_test.dart, test/gen5_test.dart	Comments and test descriptions revise claims about direction-marker fixtures, opcode classifications, gen5 record evidence, and reference-implementation attributions. Test assertions and decoder behavior are unchanged.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: droptabl

Merge Risk: ⚪ Minimal · up to fb1b4

This change does not alter command generation or decoding. Some hardware-state claims remain unverified, but no concrete regression or merge blocker is established.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title concisely describes the comment changes that focus on verified wire facts and omit provenance.
Docstring Coverage	✅ Passed	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	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

• Autopilot · 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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}