-
Notifications
You must be signed in to change notification settings - Fork 1
Document Flow model fields in AGENTS.md § 5 #97
Copy link
Copy link
Closed
Labels
area:coreCore library internalsCore library internalscomplexity:simpleStraightforward change, minimal riskStraightforward change, minimal riskdocumentationImprovements or additions to documentationImprovements or additions to documentationpriority:mediumImportant but not blockingImportant but not blockingsize:SSmall effort (< 1 day)Small effort (< 1 day)type:docsDocumentation improvementsDocumentation improvements
Metadata
Metadata
Labels
area:coreCore library internalsCore library internalscomplexity:simpleStraightforward change, minimal riskStraightforward change, minimal riskdocumentationImprovements or additions to documentationImprovements or additions to documentationpriority:mediumImportant but not blockingImportant but not blockingsize:SSmall effort (< 1 day)Small effort (< 1 day)type:docsDocumentation improvementsDocumentation improvements
Context
AGENTS.md § 5 (Executor and flow semantics) documents
FlowStep.input_mapping,ExecutionResult, andStepRecord, but does not document theFlowmodel fields themselves. The following fields inchainweaver/flow.pyare undocumented in § 5:deterministicboolTrueTrue, the executor guarantees no LLM calls between stepstrigger_conditionsdict[str, Any] | NoneNoneinput_schematype[BaseModel] | NoneNoneinitial_inputbefore the first stepoutput_schematype[BaseModel] | NoneNoneProposed change
Add a
### Flow (Pydantic model)subsection to AGENTS.md § 5 documenting these fields, similar to the existingExecutionResultandStepRecordtables.Origin
Raised during review of #94 (docs rewrite PR).