Skip to content

docs(cli): fix misattached --env / --exit-when-nodes-finish help in dora start - #2992

Merged
trunk-io[bot] merged 1 commit into
mainfrom
claude/dreamy-bardeen-dhh581-start-env-help
Aug 11, 2026
Merged

docs(cli): fix misattached --env / --exit-when-nodes-finish help in dora start#2992
trunk-io[bot] merged 1 commit into
mainfrom
claude/dreamy-bardeen-dhh581-start-env-help

Conversation

@phil-opp

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

Copy link
Copy Markdown
Collaborator

Issue

In binaries/cli/src/command/start/mod.rs, the doc comment describing --env ran — with no separating field between them — straight into the --exit-when-nodes-finish documentation, and the whole merged /// block was attached to the exit_when_nodes_finish field. The env field that followed had no doc comment at all.

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.

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 -- --check
  • cargo clippy -p dora-cli -- -D warnings

Both pass. Also verified as part of a combined full-workspace cargo test run across all three of this run's changes.


⚠️ This pull request was generated autonomously by Claude (an AI agent). It is machine-generated; please review carefully before merging.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Ltyvv3SpFoRwR3ckEDUpjQ


Generated by Claude Code

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

trunk-io Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

😎 Merged successfully - details.

phil-opp commented Aug 4, 2026

Copy link
Copy Markdown
Collaborator Author

Autonomous review run — summary

This PR is one of a small batch opened by an automated repository-review pass. All three were branched off freshly-fetched origin/main, verified individually, and gated together on the combined diff. Everything here is machine-generated by Claude (an AI agent); please review before merging.

PRs opened this run

Correctness / robustness

CLI output

Documentation

Findings examined and rejected (not turned into PRs)

  • InputMapping::Display drops node_filter when min_level is None — not a live bug: the parser and every constructor only pair a node filter with a level, so {min_level: None, node_filter: Some} is never produced; round-tripping it would require a grammar extension, not a Display fix.
  • arrow-convert TryFrom<&ArrowData> doctest — duplicate of the already-open docs(arrow-convert): add a compile-checked doctest for reading ArrowData back into Rust #2899.
  • telemetry::init_meter_provider .expect() panic — duplicate of the already-open fix(telemetry): propagate OTLP metric-exporter build failures instead of panicking #2765.
  • OperatorId skips the validation NodeId/DataId enforce — medium confidence; the actual panic/mismatch depends on an out-of-scope composition site and tightening it could reject ids currently accepted. Left for a maintainer decision.
  • mavlink UDP: first command dropped in server (udpin) mode before a peer connects — documented as intentional; the asymmetry with the data-stream retry path is by design.
  • dora doctor counts Restarting nodes as healthy — judgment call on intended semantics (restart is part of normal policy); ambiguous without maintainer intent.
  • dora record --proxy output-path comment describes resolution the code doesn't do — trivial comment/code mismatch; the safe (comment-only) fix isn't PR-worthy and the behavioral change is out of scope.
  • Minor public-API doc gaps (MavlinkArrow trait methods, telemetry::deserialize_context) — low value relative to a compile-checked target; skipped this run.

Validation

Per branch: cargo fmt --all -- --check, cargo clippy -- -D warnings, and tests for the affected crate. On the combined diff: cargo check --all (whole workspace, incl. examples and test-support crates) and cargo check --examples both pass, and full test runs of the two affected crates (dora-cli, dora-mavlink2-bridge) are green.

Note: a single cargo test --all across the whole workspace could not run to completion in this environment — the session's writable-disk allowance (~37 GB) is too small to hold a full-workspace debug test build (a separate statically-linked binary per test crate), which aborted with No space left on device / linker Bus error. Those failures were disk/linker resource errors on crates unrelated to this diff, not test or compile failures caused by the changes. Coverage was recovered via the workspace-wide cargo check --all above plus the affected-crate test suites.


Generated by Claude Code

phil-opp commented Aug 4, 2026

Copy link
Copy Markdown
Collaborator Author

No issues found.

Documentation-only change: it splits the merged doc-comment block so --env and --exit-when-nodes-finish each document their own clap field, fixing the misattribution where --help printed the --env paragraph as the description of --exit-when-nodes-finish and left --env blank. The relocated --env doc sits directly above the env: Vec<String> field, and exit_when_nodes_finish keeps its own paragraph. No behavior change.


Automated review by Claude — fully automated, not vetted by a human. Treat accordingly.

Generated by Claude Code


Generated by Claude Code

phil-opp commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator Author

Automated review — no issues found.

Verified this is a pure clap-help attribution fix: the --env doc block was previously merged into and attributed to exit_when_nodes_finish (leaving --env with no help text), and it's now correctly attached to the env field while exit_when_nodes_finish keeps its own description. No behavior change.


🤖 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

@phil-opp
phil-opp marked this pull request as ready for review August 9, 2026 11:33
@trunk-io
trunk-io Bot merged commit 9802e8e into main Aug 11, 2026
27 checks passed
@trunk-io
trunk-io Bot deleted the claude/dreamy-bardeen-dhh581-start-env-help branch August 11, 2026 12:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants