Skip to content

Commit 47546c3

Browse files
authored
docs: fix stale future comments in spec.go (#57)
## Description Remove stale `(future)` comments from `command.Spec` fields that have already been implemented: - `PollConfig` — shipped in PR #34 (`--wait` polling framework). Comment referenced "Track B" which no longer exists. - `Columns` — shipped in PRs #26-28 (M3 TUI formatting). Comment referenced "M3" as future. - `Destructive` — updated to say "not yet implemented" (accurate). Also added cross-references to where registrations live (`cmd/heygen/poll_configs.go`, `cmd/heygen/columns.go`) so future readers can find the related code. No behavior change — comments only. ## Testing `make test` passes. Comment-only change, no functional impact.
1 parent a086b99 commit 47546c3

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

internal/command/spec.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ type Spec struct {
5959

6060
// Execution behavior (used by executor)
6161
Paginated bool // true → command supports cursor pagination via API query flags like --token/--limit
62-
PollConfig *PollConfig // non-nil → pollable; defines polling behavior for --wait (future)
63-
Destructive bool // triggers --force confirmation prompt (future)
64-
Columns []Column // TUI table column definitions (future)
62+
PollConfig *PollConfig // non-nil → pollable; defines polling behavior for --wait
63+
Destructive bool // triggers --force confirmation prompt (not yet implemented)
64+
Columns []Column // TUI table column definitions for --human output
6565
}
6666

6767
// ArgSpec defines a positional argument derived from a URL path parameter.
@@ -96,8 +96,8 @@ type FlagSpec struct {
9696
JSONName string // original API parameter/field name ("folder_id")
9797
}
9898

99-
// PollConfig defines how --wait polling works for async commands (future).
100-
// Will be implemented alongside Track B (polling framework).
99+
// PollConfig defines how --wait polling works for async commands.
100+
// Registered per-command in cmd/heygen/poll_configs.go.
101101
type PollConfig struct {
102102
StatusEndpoint string // GET endpoint to check status
103103
StatusField string // JSON field containing status (e.g., "status")
@@ -107,8 +107,8 @@ type PollConfig struct {
107107
HintCommand string // CLI get command for manual follow-up (e.g. "video get")
108108
}
109109

110-
// Column defines a TUI table column for --human output (future).
111-
// Will be implemented alongside M3 (TUI formatting).
110+
// Column defines a TUI table column for --human output.
111+
// Curated per-command in cmd/heygen/columns.go.
112112
type Column struct {
113113
Header string // table column header ("Status")
114114
Field string // JSON field path, supports dot notation ("avatar.name")

0 commit comments

Comments
 (0)