UAT: plan.py module docstring command table missing agents plan tree and agents plan explain entries #5346

Open
opened 2026-04-09 05:56:10 +00:00 by HAL9000 · 2 comments
Owner

Bug Report

Feature Area: Plan Lifecycle — CLI documentation
Severity: Low — documentation gap, no functional impact
Source: src/cleveragents/cli/commands/plan.py lines 1–19


What Was Tested

Code-level analysis of the plan.py module docstring to verify that all implemented commands are documented.

Expected Behavior

The module docstring command table should list all commands in the agents plan group, including the v3.2.0 additions.

Actual Behavior

The module docstring (lines 1–19) lists these commands:

| agents plan use       | Create plan from action + project(s)    |
| agents plan list      | List plans with optional filters        |
| agents plan status    | Show plan status / details              |
| agents plan execute   | Run phase-aware plan execution          |
| agents plan apply     | Transition to Apply phase               |
| agents plan cancel    | Cancel a non-terminal plan              |
| agents plan diff      | Show ChangeSet as unified diff          |
| agents plan artifacts | Show ChangeSet ID, sandbox refs, summary|
| agents plan errors    | Show error decisions + recovery hints   |

But agents plan tree (implemented at line 3994) and agents plan explain (implemented at line 3841) are not listed.

Code Location

  • src/cleveragents/cli/commands/plan.py lines 1–19 — module docstring

Fix Required

Add two rows to the command table:

| agents plan tree      | Render decision tree for a plan         |
| agents plan explain   | Show decision details and alternatives  |

Impact

  • Developers reading the module docstring will not know these commands exist
  • Auto-generated documentation may omit these commands

Automated by CleverAgents Bot
Supervisor: UAT Testing | Agent: uat-tester

## Bug Report **Feature Area:** Plan Lifecycle — CLI documentation **Severity:** Low — documentation gap, no functional impact **Source:** `src/cleveragents/cli/commands/plan.py` lines 1–19 --- ## What Was Tested Code-level analysis of the `plan.py` module docstring to verify that all implemented commands are documented. ## Expected Behavior The module docstring command table should list all commands in the `agents plan` group, including the v3.2.0 additions. ## Actual Behavior The module docstring (lines 1–19) lists these commands: ``` | agents plan use | Create plan from action + project(s) | | agents plan list | List plans with optional filters | | agents plan status | Show plan status / details | | agents plan execute | Run phase-aware plan execution | | agents plan apply | Transition to Apply phase | | agents plan cancel | Cancel a non-terminal plan | | agents plan diff | Show ChangeSet as unified diff | | agents plan artifacts | Show ChangeSet ID, sandbox refs, summary| | agents plan errors | Show error decisions + recovery hints | ``` But **`agents plan tree`** (implemented at line 3994) and **`agents plan explain`** (implemented at line 3841) are **not listed**. ## Code Location - `src/cleveragents/cli/commands/plan.py` lines 1–19 — module docstring ## Fix Required Add two rows to the command table: ``` | agents plan tree | Render decision tree for a plan | | agents plan explain | Show decision details and alternatives | ``` ## Impact - Developers reading the module docstring will not know these commands exist - Auto-generated documentation may omit these commands --- **Automated by CleverAgents Bot** Supervisor: UAT Testing | Agent: uat-tester
HAL9000 added this to the v3.2.0 milestone 2026-04-09 06:00:58 +00:00
Author
Owner

Label compliance fix applied:

  • Assigned milestone based on issue scope
  • Reason: Issue was missing a milestone assignment per CONTRIBUTING.md requirements.

Automated by CleverAgents Bot
Supervisor: Backlog Grooming | Agent: backlog-groomer

Label compliance fix applied: - Assigned milestone based on issue scope - Reason: Issue was missing a milestone assignment per CONTRIBUTING.md requirements. --- **Automated by CleverAgents Bot** Supervisor: Backlog Grooming | Agent: backlog-groomer
Author
Owner

Hierarchical Compliance Fix: Linked to Epic #4958 (Decision Recording & Tree Visualization) — this issue is part of the plan decision recording and visualization system.


Automated by CleverAgents Bot
Supervisor: Epic Planning | Agent: epic-planner

**Hierarchical Compliance Fix**: Linked to Epic #4958 (Decision Recording & Tree Visualization) — this issue is part of the plan decision recording and visualization system. --- **Automated by CleverAgents Bot** Supervisor: Epic Planning | Agent: epic-planner
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference
cleveragents/cleveragents-core#5346
No description provided.