From 68062831b0ba54fff3f170d9f29df8fe90d1c9f9 Mon Sep 17 00:00:00 2001
From: Jeremie Fraeys <jfaeys@gmail.com>
Date: Thu, 5 Mar 2026 11:06:28 -0500
Subject: [PATCH] refactor(cli): remove redundant doc comments from command
 files

Removed duplicate help text from doc comments:
- log.zig: Removed usage examples (in printUsage)
- annotate.zig: Removed usage examples (in printUsage)
- experiment.zig: Removed usage examples (in printUsage)

Rationale: printUsage() already contains detailed help text.
Doc comments should not duplicate this information.

All tests pass.
---
 cli/src/commands/annotate.zig   | 6 ------
 cli/src/commands/experiment.zig | 5 -----
 cli/src/commands/log.zig        | 4 ----
 3 files changed, 15 deletions(-)

diff --git a/cli/src/commands/annotate.zig b/cli/src/commands/annotate.zig
index 140b72f..0a34616 100644
--- a/cli/src/commands/annotate.zig
+++ b/cli/src/commands/annotate.zig
@@ -4,12 +4,6 @@ const db = @import("../db.zig");
 const core = @import("../core.zig");
 const manifest_lib = @import("../manifest.zig");
 
-/// Annotate command - unified metadata annotation
-/// Usage:
-///   ml annotate <run_id> --text "Try lr=3e-4 next"
-///   ml annotate <run_id> --hypothesis "LR scaling helps"
-///   ml annotate <run_id> --outcome validates --confidence 0.9
-///   ml annotate <run_id> --privacy private
 pub fn execute(allocator: std.mem.Allocator, args: []const []const u8) !void {
     var flags = core.flags.CommonFlags{};
     var command_args = try core.flags.parseCommon(allocator, args, &flags);
diff --git a/cli/src/commands/experiment.zig b/cli/src/commands/experiment.zig
index f3875e2..f300057 100644
--- a/cli/src/commands/experiment.zig
+++ b/cli/src/commands/experiment.zig
@@ -24,11 +24,6 @@ const ExperimentInfo = struct {
     }
 };
 
-/// Experiment command - manage experiments
-/// Usage:
-///   ml experiment create --name "baseline-cnn"
-///   ml experiment list
-///   ml experiment show <experiment_id>
 pub fn execute(allocator: std.mem.Allocator, args: []const []const u8) !void {
     var flags = core.flags.CommonFlags{};
     var command_args = try core.flags.parseCommon(allocator, args, &flags);
diff --git a/cli/src/commands/log.zig b/cli/src/commands/log.zig
index 7f1538b..d251e37 100644
--- a/cli/src/commands/log.zig
+++ b/cli/src/commands/log.zig
@@ -7,10 +7,6 @@ const ws = @import("../net/ws/client.zig");
 const protocol = @import("../net/protocol.zig");
 const crypto = @import("../utils/crypto.zig");
 
-/// Logs command - fetch or stream run logs
-/// Usage:
-///   ml logs <run_id>              # Fetch logs from local file or server
-///   ml logs <run_id> --follow     # Stream logs from server
 pub fn run(allocator: std.mem.Allocator, args: []const []const u8) !void {
     var flags: core.flags.CommonFlags = .{};