Skip to content

chore(producer): keep the probe-needs-a-browser doc on its own function - #7554

Merged
miguel-heygen merged 1 commit into
mainfrom
chore/probe-stage-doc-placement
Nov 11, 2026
Merged

miguel-heygen merged 1 commit into
mainfrom
chore/probe-stage-doc-placement

Conversation

@miguel-heygen

Copy link
Copy Markdown
Collaborator

What changed

The doc comment for probeRequiresBrowser now sits directly on that function. A recent change inserted two helpers between the comment and the function, so the long comment described the wrong one. The comment is also cut to its one load-bearing fact.

What I measured

Comment-only diff: 4 lines added, 13 removed in probeStage.ts. oxfmt --check and oxlint are clean on the file. The comment ratchet reports a lower comment share for the file than before.

What I did NOT exercise

No behaviour changes, so I ran no tests or type check locally; CI runs them.

Size

17 lines, comment only. It is a review nit on a change that has already merged, and I have no other open change in this repository to carry it.

@github-actions

Copy link
Copy Markdown
Contributor

Edit accuracy: accurate 267 (base branch 267), smooth 103 of those

The gate passes.
Smoothness is reported in the artifact, not gated. A case fails only if it fails 2 of 3 runs.

Quarantined, measured but not gated (8)

@heygengenesis heygengenesis Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Approving at e9ead56d. No blockers.

  • The change touches only comments in probeStage.ts. probeRequiresBrowser's doc comment now sits on probeRequiresBrowser again, and checksVariablesInBrowser keeps only its own one-line doc. This resolves the nit I left on #7548.
  • This is not a fix PR, so it does not need a fails without the fix: line.
  • CI at this head: CI, regression, Windows render, Comments, CodeQL and the captures all pass.

Non-blocking: the shortened comment drops the R4 caveat. A known-duration, media-free composition that builds many nodes in its init script is measured statically and must never reach the band's applied cohort. That is the non-obvious invariant behind this predicate. If a later change wants it back, a short pointer to resolveDeShortBand would keep it findable without raising the file's comment share much.

@miguel-heygen
miguel-heygen added this pull request to the merge queue Nov 11, 2026
Merged via the queue into main with commit 3e04a59 Nov 11, 2026
90 checks passed
@miguel-heygen
miguel-heygen deleted the chore/probe-stage-doc-placement branch November 11, 2026 16:36
@heygengenesis heygengenesis Bot mentioned this pull request Nov 11, 2026
3 of 4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant