Skip to content

Fix dangling [Reset] godoc links in workflow binding - #1085

Open
PratikDhanave (PratikDhanave) wants to merge 1 commit into
microsoft:mainfrom
PratikDhanaveFork:binding-reset-godoc-links
Open

PratikDhanave (PratikDhanave) wants to merge 1 commit into
microsoft:mainfrom
PratikDhanaveFork:binding-reset-godoc-links

Conversation

@PratikDhanave

Copy link
Copy Markdown
Contributor

Two godoc links in workflow/binding.go reference a method that doesn't exist:

  • SharedInstance doc: "…participate in workflow reset checks through [Reset]."
  • TryReset doc: "…report success without invoking [ExecutorBinding.Reset]."

ExecutorBinding has no Reset method — reset is exposed via TryReset (backed by the ResetFunc field). Both links are dangling and don't render. Repointed them at [ExecutorBinding.TryReset]. Doc-only change.

ExecutorBinding has no Reset method; reset is exposed via TryReset (backed by
the ResetFunc field). Point the two doc links at [ExecutorBinding.TryReset] so
they resolve.
Copilot AI lite review requested due to automatic review settings September 16, 2026 07:44
@github-actions github-actions Bot added area:workflow Changes files in the workflow area size:small At most 30 changed lines across at most 2 files labels Sep 16, 2026

Copilot AI 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.

🟡 Changes recommended

The TryReset documentation still needs an accurate reset-callback reference.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Fixes dangling godoc links in workflow/binding.go by referencing existing reset APIs.

Changes:

  • Updates reset-related documentation links.
  • References ExecutorBinding.TryReset.
File summaries
File Description
workflow/binding.go Corrects reset-related documentation links.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread workflow/binding.go
// TryReset resets this binding if it wraps a shared executor instance.
// Non-shared bindings are already isolated per session and therefore report
// success without invoking [ExecutorBinding.Reset].
// success without invoking [ExecutorBinding.TryReset].
@github-actions

Copy link
Copy Markdown
Contributor

Scope: internal-only (doc comment fix)
Changed Go contract: None — only godoc comment text in workflow/binding.go was updated to fix two dangling [Reset] links, repointing them to [ExecutorBinding.TryReset].
Upstream evidence reviewed: Not applicable — no exported API, defaults, or runtime behavior changed. No upstream .NET/Python comparison is required for a doc-only godoc link fix.
Result: out of scope

This PR only corrects broken godoc cross-references (comment text) and adds no new/changed exported identifiers or observable behavior. No cross-repo parity review is applicable.

Generated by Go API Consistency Review Agent · copilot · auto · 12.3 AIC · ⌖ 5.74 AIC · ⊞ 9.6K ·

@github-actions github-actions Bot added the kind:docs Changes documentation or comments label Sep 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:workflow Changes files in the workflow area kind:docs Changes documentation or comments size:small At most 30 changed lines across at most 2 files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants