Skip to content

docs(embed): drop the private module link from TurnSteering::steer - #7914

Merged
M3gA-Mind merged 1 commit into
tinyhumansai:mainfrom
M3gA-Mind:fix/embed-steer-doc-link
Oct 16, 2026
Merged

M3gA-Mind merged 1 commit into
tinyhumansai:mainfrom
M3gA-Mind:fix/embed-steer-doc-link

Conversation

@M3gA-Mind

@M3gA-Mind M3gA-Mind commented Oct 16, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Fixes the embed-rustdoc lane on main: TurnSteering::steer's public docs link to the private turn_steering module ([module docs](self)), which cargo doc rejects under RUSTDOCFLAGS=-D warnings (rustdoc::private_intra_doc_links).
  • Docs-only: the link is replaced with the two run-time checkpoints it pointed to.

Problem

bash scripts/ci-cancel-aware.sh cargo doc -p openhuman-embed --no-deps with RUSTDOCFLAGS=-D warnings (the embed-rustdoc lane, scripts/ci/self-hosted/lanes-plan.mjs) fails on main 9a25e9d:

error: public documentation for `steer` links to private item `self`
  --> crates/openhuman-embed/src/turn_steering.rs:82:32

turn_steering is declared mod turn_steering; in lib.rs; only TurnSteering and SteerRefused are re-exported, so the module docs are never published.

Solution

  • Drop the link and name the checkpoints inline, so steer's public docs no longer depend on module docs that are never published: after a tool batch has settled, or when the model has written what would be its final answer. The case before the first model call is already covered by the previous sentence.
  • The module docs are unchanged.

Submission Checklist

  • (N/A) Tests added or updated: doc comment only.
  • (N/A) Diff coverage ≥ 80%: no code lines changed.
  • (N/A) Coverage matrix updated: no feature rows added or removed.
  • (N/A) All affected feature IDs listed: no matrix rows change.
  • No new external network dependencies introduced
  • (N/A) Manual smoke checklist: no release-cut surface changes.
  • (N/A) Linked issue closed: no issue; main embed-rustdoc lane red.

Impact

  • CI: unblocks embed-rustdoc.
  • Runtime: none.

Related


AI Authored PR Metadata (required for Codex/Linear PRs)

Linear Issue

  • Key: N/A
  • URL: N/A

Commit & Branch

  • Branch: fix/embed-steer-doc-link
  • Commit SHA: see the PR head

Validation Run

  • (N/A) pnpm --filter openhuman-app format:check: no frontend files changed.
  • (N/A) pnpm typecheck: no frontend files changed.
  • Focused tests: none run locally (team rule); CI runs them.
  • Rust fmt/check (if changed): the lane's exact command was run once on main 9a25e9d and failed with only this error. The fix removes that link; this PR's CI runs the lane.
  • (N/A) Tauri fmt/check: no Tauri source changed.

Validation Blocked

  • command: N/A
  • error: N/A
  • impact: N/A

Behavior Changes

  • Intended behavior change: none.
  • User-visible effect: none.

Parity Contract

  • Legacy behavior preserved: yes; doc comment only.
  • Guard/fallback/dispatch parity checks: N/A.

Duplicate / Superseded PR Handling

  • Duplicate PR(s): none (no open PR touches turn_steering.rs or embed rustdoc)
  • Canonical PR: this
  • Resolution (closed/superseded/updated): N/A

Summary by CodeRabbit

  • Documentation
    • Clarified that queued steering messages take effect after a tool batch completes or when the model is ready to give its final answer. Steering does not interrupt an active model call or tool.

The turn_steering module is private, so the [module docs](self) link
fails cargo doc with RUSTDOCFLAGS=-D warnings (private_intra_doc_links).
Name the run-time checkpoints inline instead.
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-16T08:15:17.474181Z 2421a8d PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: d6ffe338-6fed-4d00-869d-2f2e304e4751
📥 Commits

Reviewing files that changed from the base of the PR and between 9a25e9d and 2421a8d.

📒 Files selected for processing: 1
  • crates/openhuman-embed/src/turn_steering.rs

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

📝 Walkthrough

The TurnSteering::steer documentation now identifies when queued messages are applied and states that steering does not interrupt an active model call or tool.

Changes: Turn steering documentation

Layer / File(s) Summary
Document steering checkpoints
crates/openhuman-embed/src/turn_steering.rs
The steer documentation names the safe checkpoints for applying queued messages and clarifies that active model calls and tools are not interrupted.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: senamakel

Merge Risk: ⚪ Minimal · up to 2421a

This is a documentation-only change that fixes a doc build failure and has no runtime impact. It is safe to merge.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title accurately and clearly identifies the main documentation change: removing the private module link from TurnSteering::steer.
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 1…
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.
Full details: Docstring Coverage

Explanation

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 1 files.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

A rabbit reads the checkpoint note,
Queued messages wait their turn to float.
Tool batches settle, answers near,
The safe points now read clear.
Calls and tools run to their end,
Then steering messages may attend.

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

@tinysweeper

tinysweeper Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Tiny Sweeper review

Tiny Sweeper reviewed this change across 5 lane(s) and found 0 active actionable finding(s). Detailed lane evidence and any incomplete work are listed below.

State: Ready for maintainer review
Priority: none
Reviewed head: 2421a8d091a0
Updated: 2026-10-16T08:34:45Z

Review snapshot

Change surface Files Review signal Count
Production 1 Active findings 0
Tests 0 Noted findings 0
Documentation 0 Resolved findings 0
Configuration 0 Pending checks/questions 0

Completeness: Complete
Test assessment: No supported feature-to-test mapping was available; this does not mean tests are absent or passed.

Features

None identified with supported citations.

Tests

No supported feature-to-test mapping was produced. Test execution is not inferred.

Findings

No active actionable findings.

Before merge

None.

How this fits together

flowchart LR
  n0["TurnSteering<br/>changed"]:::changed
  n1["Turn"]:::impacted
  n2["steering_handle"]:::impacted
  n3["state"]:::impacted
  n4["steer"]:::impacted
  n5["hands_back_steers"]:::impacted
  n6["take_unapplied"]:::impacted
  n1 -->|uses| n0
  n2 -->|uses| n0
  n4 -->|calls| n3
  n5 -->|uses| n0
  n5 -->|calls| n6
  n5 -->|tests| n6
  n6 -->|calls| n3
  classDef changed fill:#0d4429,stroke:#238636,color:#e6edf3
  classDef impacted fill:#161b22,stroke:#6e7681,color:#c9d1d9
  classDef flagged fill:#5a1e02,stroke:#d93f0b,color:#ffffff
  classDef blocking fill:#67060c,stroke:#f85149,color:#ffffff
Loading
Agent review details

critique

  • Conclusion: Success
  • Scope reviewed: all assigned evidence
  • Lane summary: This is a doc-only change to `TurnSteering::steer`'s comment, replacing a pointer to the module docs with an explicit enumeration of the mid-run checkpoints. It matches the module docs for the two checkpoints it names, but it now asserts that a steer sent while the turn runs is applied only after a tool batch or at the draft-answer point, omitting the before-the-first-model-call checkpoint that the unchanged doc on `Turn::steering_handle` still lists for `steer()` unscoped; whether that omission is accurate turns on the tinyagents harness loop, which I could not inspect. One low-confidence finding on that; otherwise the change looks safe to merge. _The code index is behind this pull request (indexed at `bcee6c972558`), so retrieved context may be out of date._

security

  • Conclusion: Success
  • Scope reviewed: all assigned evidence
  • Lane summary: The only change is a doc-comment rewrite on `TurnSteering::steer`; no executable code, no new inputs, sinks, or permission changes. The rewording stays consistent with the surrounding text and the README's description of the checkpoints. Nothing to report from a security standpoint. _The code index is behind this pull request (indexed at `bcee6c972558`), so retrieved context may be out of date._

tests

  • Conclusion: Success
  • Scope reviewed: all assigned evidence
  • Lane summary: The diff is documentation-only: it rewrites the doc comment on `TurnSteering::steer`, replacing a link to the module docs with an inline list of the mid-turn checkpoints (after a tool batch settles, or when the model has written its final answer). There is no behavioural change — no executable line moves — so no new or updated test is warranted, and none is demanded. The enumerated checkpoints match the crate README and the existing e2e coverage (tests/turn_steering.rs exercises the final-answer checkpoint end to end, and turn_steering_tests.rs covers the queue/refusal/lane behaviour), so the restated invariant is not merely a claim; it is already pinned. The change looks sound. _The code index is behind this pull request (indexed at `bcee6c972558`), so retrieved context may be out of date._

commits

  • Conclusion: Neutral
  • Scope reviewed: all assigned evidence
  • Lane summary: Nothing sensitive found in what this pull request commits.

description

  • Conclusion: Success
  • Scope reviewed: all assigned evidence
  • Lane summary: Docs-only change that matches its description exactly: the private intra-doc link `[module docs](self)` on `TurnSteering::steer` is replaced with an inline statement of the two run-time checkpoints, which faithfully restates the module docs ("after a tool batch has settled", "when the model has written what would be its final answer"). No code changes, no repo rules touched, nothing to report. _The code index is behind this pull request (indexed at `bcee6c972558`), so retrieved context may be out of date._
Evidence and run details
  • Models: ladder/vectors-oai3, glm-5.3-flash
  • Spend: $0.003701
  • Tokens: 103451 input · 13365 output · 2048 cached · 61 embedding
Head State Pass summary
2421a8d091a0 ready for maintainer review 0 active finding(s), 0 resolved finding(s) (at 2026-10-16T08:34:45Z)

tinysweeper 0.1.2

@tinysweeper tinysweeper Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tinysweeper found nothing blocking. Approving.

             $0.0037 · 103,451 in / 13,365 out · 2,048 cached (2%) · ladder/vectors-oai3, glm-5.3-flash · 61 embedded
critique:    $0.0029 · 63,023 in  / 11,437 out · 2,048 cached (3%) · glm-5.3-flash
security:    $0.0002 · 12,846 in  / 291 out    · 0 cached (0%)     · glm-5.3-flash
tests:       $0.0002 · 12,861 in  / 537 out    · 0 cached (0%)     · glm-5.3-flash
description: $0.0002 · 13,050 in  / 382 out    · 0 cached (0%)     · glm-5.3-flash

@tinysweeper tinysweeper Bot added the priority: p3 Whenever. Cosmetic, a nicety, or a cleanup with no user visible effect. label Oct 16, 2026
@M3gA-Mind
M3gA-Mind merged commit 6557120 into tinyhumansai:main Oct 16, 2026
25 of 27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority: p3 Whenever. Cosmetic, a nicety, or a cleanup with no user visible effect.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant