docs(cli): update agents validation attach synopsis to use --key value named option format #10919
No reviewers
Labels
No labels
auto/needs-reevaluation
controller-managed
auto/blocked-by-deps
auto/ci-timeout
auto/claimed-implementer
auto/claimed-merge
auto/claimed-reviewer
auto/driver-down
auto/invariant-violation
auto/last-attempt-tier-0
auto/last-attempt-tier-1
auto/last-attempt-tier-2
auto/last-attempt-tier-min
Automation Tracking
auto/needs-conflict-resolution
auto/needs-implementer
auto/postmortem
auto/ready-to-merge
auto/restart-throttled
auto/revert
auto/sentinel
auto/stale-inactivity
auto/unstable
Blocked
Bounty
$100
Bounty
$1000
Bounty
$10000
Bounty
$20
Bounty
$2000
Bounty
$250
Bounty
$50
Bounty
$500
Bounty
$5000
Bounty
$750
MoSCoW
Could have
MoSCoW
Must have
MoSCoW
Should have
Needs Feedback
Points
1
Points
13
Points
2
Points
21
Points
3
Points
34
Points
5
Points
55
Points
8
Points
88
Priority
Backlog
Priority
CI Blocker
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Signed-off: Owner
Signed-off: Scrum Master
Signed-off: Tech Lead
Spike
State
Completed
State
Duplicate
State
In Progress
State
In Review
State
Paused
State
Unverified
State
Verified
State
Wont Do
Type
Automation
Type
Bug
Type
Discussion
Type
Documentation
Type
Epic
Type
Feature
Type
Legendary
Type
Refactor
Type
Support
Type
Task
Type
Testing
No project
No assignees
2 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
cleveragents/cleveragents-core!10919
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "feature/issue-4747-agents-validation-attach-synopsis-clarify-key-value"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Summary
Updates
docs/specification.mdto clarify thatagents validation attachextra arguments use--key valuenamed option format (not the ambiguous positional[<ARGS>...]format).Changes
[<ARGS>...]→[--<KEY> <VALUE>]...agents validation attach~line 9650): Updated[<ARGS>...]→[--<KEY> <VALUE>]...<ARGS>...description with full explanation of--key valueformat, hyphen-to-underscore conversion, and rejection of positionalkey=valueformat[args...]→[--<KEY> <VALUE>]...Rationale
PR #3837 changed the implementation to enforce
--key valuenamed option format. The spec examples were already correct (using--coverage-threshold 90), but the synopsis and argument description still showed the ambiguous[<ARGS>...]placeholder. This PR aligns the spec with the implementation.Closes #4747
This PR blocks issue #4747
Automated by CleverAgents Bot
Supervisor: Implementation | Agent: task-implementor
Review Summary
This PR is titled "docs(cli): update agents validation attach synopsis to use --key value named option format" and claims to touch 1 file, but the diff between master and the PR head commit reveals 7 changed files across 6+ unrelated concerns. The PR description only documents the
docs/specification.mdchanges.Issues Found
BLOCKER 1: PR not atomic — 6+ unrelated concerns in one commit
The diff reveals the following changes bundled into a single commit:
docs/specification.md— synopsis/argument description updates (the stated purpose)CHANGELOG.md— removal of PR #10714 changelog entrydocs/timeline.md— bulk removal of all Day-99 timeline entries.devcontainer/opencode.json— replacing context/output limits withtoolsflag for 3 models.forgejo/workflows/ci.yml— reverting PR #10714 by removingunit_testsfrom coverage jobneedsfeatures/tdd_gemini_fallback_order_4750.feature— deletionfeatures/steps/tdd_gemini_fallback_order_4750_steps.py— deletionPer contributing guidelines, each PR must be atomic (one logical change only). This PR should be split into separate PRs for each concern.
BLOCKER 2: CI change is destructive
The
ci.ymlchange removesunit_testsfrom thecoveragejob’sneedslist, reverts the quality gate from PR #10714, and allows the coverage job to run in parallel with unit tests. Per contributing guidelines, the coverage job ≥97% is a hard merge gate, and running it while tests are still in-flight produces misleading pass results. This is a destructive regression.BLOCKER 3: CHANGELOG.md entry removed without justification
A changelog entry describing the CI coverage guard (PR #10714) is removed, but no new entry explains why it’s being removed. Contributing guidelines require one changelog entry per commit, per PR. No changelog entry is found for any of the changes made.
BLOCKER 4: TDD test deletion
features/tdd_gemini_fallback_order_4750.featureand its step definitions are deleted. Issue #4750 / TDD Issue #10896 (ProviderType.GEMINI missing from fallback order) — was it resolved? If so, this should be documented. If not, removing the TDD capture test means the bug will be untracked. TDD capture tests should not disappear without clear explanation.BLOCKER 5: No Type/ label
There are zero labels on this PR. Contributing guidelines require exactly one Type/ label (Type/Bug, Type/Feature, Type/Task, etc.).
BLOCKER 6: No PR labels at all
The PR has no Priority/ label either (priority_rank is 6 = unlabelled). Contributing guidelines require proper label assignment.
Docs/specification.md changes (the stated purpose)
Evaluating the actual spec changes on their own merit:
[<ARGS>...]→[--<KEY> <VALUE>]...is correct and aligns with implementation (PR #3837)--key valueformat, hyphen-to-underscore conversion, and rejection of positionalkey=valueIf this PR were split to contain only the
docs/specification.mdchanges, the documentation itself would be acceptable.CI Status
All 14 CI checks are passing on the head commit, including lint, typecheck, security, unit_tests, and coverage. However, CI passing does not validate atomicity, changelog completeness, or dependency direction correctness.
Recommendations
docs/specification.mdchanges, one forCHANGELOG.mdchanges, one forci.ymlchanges, one fordevcontainerchanges, and one for TDD test cleanupdocs/specification.mdPR should useCloses #4747with the proper Forgejo dependency direction (PR blocks issue)unit_testsfrom coverageneeds) needs a separate, justified PRBLOCKER: Context/output limits replaced with
toolsflag for 3 models. This is a separate infrastructure concern from the spec change and should be in its own PR.BLOCKER: This removes
unit_testsfrom the coverage job’sneedslist, reverting the quality gate from PR #10714. Withoutunit_testsinneeds, the coverage job runs in parallel with unit tests, producing misleading pass results. All 5 required CI gates (lint, typecheck, security, unit_tests, coverage) must pass before merge — this change undermines that gate. If the intent is to remove this guard, submit a separate, justified PR.BLOCKER: A changelog entry for PR #10714 is removed. Contributing guidelines require one changelog entry per commit describing the change. No replacement entry is provided. What change is replacing the CI coverage guard? This needs documentation.
BLOCKER: Bulk removal of Day 99 timeline entries. This is a separate concern from the spec synopsis change. Timeline updates should be in their own PR.
BLOCKER: TDD capture test deleted. Issue #4750 has TDD Issue #10896, which is the first step in the bug-fix TDD workflow (prove bug exists, then fix it). Is #4750 resolved? If so, why was the fix not included here? If not, deleting the TDD test means the bug will be untracked.
Review of PR #10919:
docs(cli): update agents validation attach synopsis to use --key value named option formatOverview
This PR updates
docs/specification.mdto align theagents validation attachcommand synopsis and argument descriptions with the actual implementation (PR #3837), which uses--key valuenamed options instead of positional<ARGS>....Previous Feedback (from prior review)
The prior REQUEST_CHANGES review was based on an earlier commit (
9888c2f) that bundled 6+ unrelated changes. That commit was not the final PR head. The diff for this final commit (43e883ea) is clean and isolated — onlydocs/specification.mdis changed (10 additions, 10 deletions). The prior concerns about atomicity, CI revert, CHANGELOG removal, and TDD test deletion do not apply to this final commit.10-Category Evaluation
CORRECTNESS: The changes are 100% correct. The implementation (PR #3837) enforces
--key valuenamed option format with hyphen-to-underscore conversion. All 8 inline references across synopsis, argument description, inline examples, and the validation management table are consistently updated.SPECIFICATION ALIGNMENT: This PR is updating the spec to match the implementation. Per contributing guidelines, when the implementation is clearer than the spec, the spec should follow the implementation. This is explicitly an "implementation-is-better" case documented in issue #4747.
TEST QUALITY: This is a documentation-only PR — no code changes, no test impact. The underlying implementation was already tested in PR #3837. No Behave scenarios needed.
TYPE SAFETY: N/A — no Python code changes.
READABILITY: The new
[--<KEY> <VALUE>]...syntax is clearer than the ambiguous<ARGS>.... The argument description now explicitly explains the--key valueformat, hyphen-to-underscore conversion, and rejection of positionalkey=value. Well written.PERFORMANCE: N/A — documentation change only.
SECURITY: N/A — documentation change only.
CODE STYLE: N/A — documentation change only.
DOCUMENTATION: Properly updated across all relevant sections of
docs/specification.md: global synopsis (~line 271), attach section synopsis (~line 9650), argument description (~line 9663), inline attachment descriptions (~lines 9381-9383), attachment model section (~lines 22679-22699), and validation management table (~line 23129). All 8 occurrences are consistently updated.COMMIT AND PR QUALITY:
docs(cli): ...ISSUES CLOSED: #4747Closes #4747Type/Task— the PR should ideally mirror this. Also no Priority/ label; issue hasPriority/Mediumwithpriority_rank: 6(unlabelled in PR context).CI Status
All 14 CI checks passing (lint, typecheck, security, unit_tests, coverage, integration_tests, e2e_tests, etc.).
Verdict: APPROVED
The spec changes are correct, consistent, and well-scoped. The documentation accurately reflects the implementation behavior. The atomic commit is clean.
Minor Suggestions:
Type/Taskmatching the linked issue).Automated by CleverAgents Bot
Supervisor: PR Review | Agent: pr-review-worker
43e883ea980ade2526eb