docs(cli): fix misattached --env / --exit-when-nodes-finish help in dora start - #2992
Conversation
…dora start` The doc comment describing `--env` ran, with no separating field, straight into the `--exit-when-nodes-finish` documentation, and the whole merged block was attached to the `exit_when_nodes_finish` field. As a result `dora start --help` printed the entire "Set an environment variable…" paragraph as the description of `--exit-when-nodes-finish`, while `--env` itself showed no description at all. Split the block so each flag documents its own field, mirroring the correct layout already present in `dora run` (binaries/cli/src/command/run.rs). No behavior change — this is a rustdoc/clap-help attribution fix only. Validation: `cargo fmt --all -- --check` and `cargo clippy -p dora-cli -- -D warnings` pass. This change was generated autonomously by Claude (an AI agent). It is machine-generated; please review carefully before merging. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Ltyvv3SpFoRwR3ckEDUpjQ
|
😎 Merged successfully - details. |
Autonomous review run — summaryThis PR is one of a small batch opened by an automated repository-review pass. All three were branched off freshly-fetched PRs opened this runCorrectness / robustness
CLI output
Documentation
Findings examined and rejected (not turned into PRs)
ValidationPer branch:
Generated by Claude Code |
|
No issues found. Documentation-only change: it splits the merged doc-comment block so Automated review by Claude — fully automated, not vetted by a human. Treat accordingly. Generated by Claude Code Generated by Claude Code |
|
Automated review — no issues found. Verified this is a pure clap-help attribution fix: the 🤖 Fully automated review by Claude (Claude Code) — no human has reviewed these findings. Please verify before relying on them. Generated by Claude Code Generated by Claude Code |
Issue
In
binaries/cli/src/command/start/mod.rs, the doc comment describing--envran — with no separating field between them — straight into the--exit-when-nodes-finishdocumentation, and the whole merged///block was attached to theexit_when_nodes_finishfield. Theenvfield that followed had no doc comment at all.As a result,
dora start --helpprinted the entire "Set an environment variable…" paragraph as the description of--exit-when-nodes-finish, while--envitself showed no description.Fix
Split the block so each flag documents its own field, mirroring the already-correct layout in
dora run(binaries/cli/src/command/run.rs). No behavior change — this is a rustdoc / clap-help attribution fix only.Validation
cargo fmt --all -- --checkcargo clippy -p dora-cli -- -D warningsBoth pass. Also verified as part of a combined full-workspace
cargo testrun across all three of this run's changes.🤖 Generated with Claude Code
https://claude.ai/code/session_01Ltyvv3SpFoRwR3ckEDUpjQ
Generated by Claude Code