Skip to content

docs(cli): attach --env help to the right field in dora start - #3099

Closed
phil-opp wants to merge 1 commit into
mainfrom
claude/dreamy-bardeen-tkzcup-start-env-doc
Closed

docs(cli): attach --env help to the right field in dora start#3099
phil-opp wants to merge 1 commit into
mainfrom
claude/dreamy-bardeen-tkzcup-start-env-doc

Conversation

@phil-opp

@phil-opp phil-opp commented Aug 9, 2026

Copy link
Copy Markdown
Collaborator

Issue

In binaries/cli/src/command/start/mod.rs, the env field's doc-comment block was written above the exit_when_nodes_finish field, with no field in between:

/// Set an environment variable for every node of this dataflow
/// ... (env docs) ...
/// visible in `ps` — prefer a node `env:` block for secrets.
/// Exit once every node has finished, treating `dora/timer/...`   // exit_when_nodes_finish docs
/// ...
#[clap(long, num_args = 0..=1, ...)]
pub exit_when_nodes_finish: Option<bool>,
#[clap(long = "env", value_name = "KEY=VALUE")]
env: Vec<String>,   // <- no doc comment

In clap's derive (like Rust doc comments) a /// block attaches to the next item. So both blocks concatenated onto exit_when_nodes_finish, and env got none. The result in dora 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 run command (run.rs) has the correct layout — one doc block per field — so start was 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).

⚠️ This is a machine-generated pull request authored by Claude (Claude Code). A human should review before merging.

🤖 Generated with Claude Code


Generated by Claude Code

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
@trunk-io

trunk-io Bot commented Aug 9, 2026

Copy link
Copy Markdown
Contributor

Merging to main in this repository is managed by Trunk.

  • To merge this pull request, check the box to the left or comment /trunk merge below.

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

Copy link
Copy Markdown
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 --env help block previously sat above exit_when_nodes_finish with no field between them, so clap's derive attached it to exit_when_nodes_finish and left --env undocumented. The diff relocates each block directly above its own field, matching run.rs. No logic or flag changes, and the text is moved verbatim.


Generated by Claude Code

@phil-opp

Copy link
Copy Markdown
Collaborator Author

Duplicate of #2992

@phil-opp phil-opp marked this as a duplicate of #2992 Aug 11, 2026
@phil-opp phil-opp closed this Aug 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants