glm-5.1
e592caed57
Review of all ADR documents (001-007) and peripheral architecture docs identified 3 critical, 10 warning, and 7 suggestion issues. Addressed in this commit: - W-1: Add draft qualifier to ADR-002 reference to incremental exploration - W-2: Add Alternatives Considered section to ADR-001 - W-3: Add Document Lifecycle section to README.md (draft/stable/deprecated) - W-4: Clarify includeCompleted semantics (only 'completed' status triggers exclusion) - W-5: Document file I/O runtime constraints in frontmatter.md - W-6: Add ADR reference to architecture.md redirect - W-7: Verify CVE-2025-64718 (confirmed real, improved description) - W-9: Convert workspace-absolute paths to relative/monorepo references - S-7: Add future ADR-008 note to incremental-update-exploration.md Critical issues (C-1, C-2, C-3) and remaining warnings (W-8, W-10, S-4, S-5) were addressed by a parallel agent in a prior commit. All 16 review tasks created and resolved.
23 lines
781 B
Markdown
23 lines
781 B
Markdown
---
|
|
id: architecture/w-8-limit-param-docs
|
|
name: Document WorkflowCostOptions.limit semantics
|
|
status: completed
|
|
depends_on:
|
|
- architecture/w-4-taskstatus-enum-values
|
|
created: 2026-04-26T09:10:59.676682205Z
|
|
modified: 2026-04-26T09:10:59.676682713Z
|
|
scope: narrow
|
|
risk: medium
|
|
---
|
|
|
|
# Description
|
|
|
|
**Review ref**: W-8 (Warning)
|
|
**Files affected**: `docs/architecture/api-surface.md`
|
|
|
|
`WorkflowCostOptions` includes `limit?: number` with no documentation of what this parameter constrains or its default behavior. Document what `limit` does (number of tasks in result? max depth?) and its behavior when omitted.
|
|
|
|
Depends on W-4 (TaskStatus definition) if `limit` interacts with `includeCompleted` filtering semantics.
|
|
|
|
**Source**: `/docs/reviews/architecture-review-2026-04-26.md` W-8
|