docs(cli): attach --env help to the right field in dora start - #3099
Closed
phil-opp wants to merge 1 commit into
Closed
docs(cli): attach --env help to the right field in dora start#3099phil-opp wants to merge 1 commit into
--env help to the right field in dora start#3099phil-opp wants to merge 1 commit into
Conversation
The `env` field's doc comment was placed above the `exit_when_nodes_finish` field with no field in between, so in clap's derive the entire block attached to `--exit-when-nodes-finish`. As a result `dora start --help` showed the `--exit-when-nodes-finish` entry beginning "Set an environment variable for every node..." and `--env` with no description at all. Reorder so each doc block sits directly above its own field, matching the correct layout already present in `dora run` (run.rs). Pure doc-comment move; no behavior change. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01K1Fmp8pELuTiPGTStomkZj
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 is a pure doc-comment move: the Generated by Claude Code |
Collaborator
Author
|
Duplicate of #2992 |
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
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.
Issue
In
binaries/cli/src/command/start/mod.rs, theenvfield's doc-comment block was written above theexit_when_nodes_finishfield, with no field in between:In clap's derive (like Rust doc comments) a
///block attaches to the next item. So both blocks concatenated ontoexit_when_nodes_finish, andenvgot none. The result indora start --help:--exit-when-nodes-finish <BOOL>— help text begins "Set an environment variable for every node of this dataflow…" (wrong).--env <KEY=VALUE>— no description at all.The sibling
dora runcommand (run.rs) has the correct layout — one doc block per field — sostartwas the regressed copy.Fix
Reorder the two doc blocks so each sits directly above its own field, mirroring
run.rs. This is a pure doc-comment move — no logic, no flag, and no behavior changes.Validation
cargo +1.97.1 fmt -p dora-cli -- --check— clean.cargo +1.97.1 clippy -p dora-cli -- -D warnings— clean (compiles with the change).🤖 Generated with Claude Code
Generated by Claude Code