docs: Remove misleading RequestInfoExecutor references#418
Open
ericchansen wants to merge 1 commit intomicrosoft:mainfrom
Open
docs: Remove misleading RequestInfoExecutor references#418ericchansen wants to merge 1 commit intomicrosoft:mainfrom
ericchansen wants to merge 1 commit intomicrosoft:mainfrom
Conversation
Replace references to non-existent RequestInfoExecutor class in MAGENTIC_README.md and STATE_MANAGEMENT.md with accurate RC1 API descriptions. Plan review is handled internally by the orchestrator via enable_plan_review=True and WorkflowEvent(type="request_info"). This addresses the confusion reported in microsoft#339 where users attempted to import RequestInfoExecutor based on documentation references. Closes microsoft#339 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Summary
Fixes #339
Removes misleading references to
RequestInfoExecutorfrom two documentation files. This non-existent class was referenced as if it were importable fromagent_framework, causing users to attemptfrom agent_framework import RequestInfoExecutorand hit anImportError.Changes
MAGENTIC_README.md(line 131) — ReplacedRequestInfoExecutorreference with accurate RC1 description: plan review is built intoMagenticOrchestratorExecutorviaenable_plan_review=True, emittingWorkflowEvent(type="request_info")events containingMagenticPlanReviewRequestdata.STATE_MANAGEMENT.md(line 411) — ReplacedRequestInfoExecutorreference with accurate description of plan-review checkpoint state managed by the orchestrator viaWorkflowEvent(type="request_info").Root Cause Analysis
RequestInfoExecutorwas never an importable class in any version ofagent-framework. It was only mentioned in documentation as a conceptual component. In RC1, plan review is handled internally byMagenticOrchestratorExecutorand exposed via the unifiedWorkflowEventmodel.Testing
RequestInfoExecutorin the codebase viagreptest_agent_framework_rc1_regression.py— all 36 locally-runnable tests pass (15 failures are pre-existing due to missingagent_framework_orchestrationspackage in test env)