docs(cli): split the merged --env / --exit-when-nodes-finish help on dora start - #3062
Closed
phil-opp wants to merge 1 commit into
Closed
docs(cli): split the merged --env / --exit-when-nodes-finish help on dora start#3062phil-opp wants to merge 1 commit into
--env / --exit-when-nodes-finish help on dora start#3062phil-opp wants to merge 1 commit into
Conversation
…`dora start` On `dora start`, the doc comment intended for `--env` ran uninterrupted into the one for `--exit-when-nodes-finish`, so the whole block annotated `exit_when_nodes_finish` and the `env` field had no doc at all. `dora start --help` therefore showed `--exit-when-nodes-finish` with a blob whose first half describes `--env`, and `--env` with no description. The sibling `dora run` command already keeps the two separate; this propagates the same split to `start`. Move the exit-policy paragraphs above `exit_when_nodes_finish` and the environment-variable paragraphs above the `env` field. Doc-comment reordering only — no code or behavior change. This is a machine-generated change authored by Claude (Claude Code), an AI assistant, and has been verified with fmt and clippy. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RoWA8SwvteRHxQ7npJsCyi
Contributor
|
Merging to
After your PR is submitted to the merge queue, this comment will be automatically updated with its status. If the PR fails, failure details will also be posted here |
Collaborator
Author
|
🤖 Automated review by Claude Code — fully automated review, not vetted by a human. No issues found. This only moves the doc-comment paragraphs so the exit-policy text sits above Generated by Claude Code |
phil-opp
marked this pull request as ready for review
August 9, 2026 11:33
Collaborator
Author
|
Closing as a duplicate of #2992 — the two diffs are byte-identical, so keeping the earlier PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
On
dora start(binaries/cli/src/command/start/mod.rs), the doc comment intended for--envran without a break straight into the doc comment for--exit-when-nodes-finish. In Rust the entire block therefore annotates the field that follows it (exit_when_nodes_finish), and theenvfield below had no doc comment at all.Result:
dora start --helpshows--exit-when-nodes-finishwith a large help blob whose first ~13 lines actually describe--env, while--envshows no description. The siblingdora runcommand (run.rs) already keeps the two descriptions separate — this was just never propagated tostart.Fix
Split the block so each field carries its own help:
exit_when_nodes_finishenvfieldPure doc-comment reordering; the field declarations,
#[clap(...)]attributes, and runtime behavior are unchanged.Validation
cargo clippy -p dora-cli --lib -- -D warningscargo fmt -p dora-cli -- --check🤖 Generated with Claude Code
Generated by Claude Code