Skip to content

docs(cli): align --stop-after help examples with duration units - #3077

Closed
loukikjoshi06-ops wants to merge 1 commit into
dora-rs:mainfrom
loukikjoshi06-ops:docs/fix-stop-after-help-examples-2867
Closed

docs(cli): align --stop-after help examples with duration units#3077
loukikjoshi06-ops wants to merge 1 commit into
dora-rs:mainfrom
loukikjoshi06-ops:docs/fix-stop-after-help-examples-2867

Conversation

@loukikjoshi06-ops

Copy link
Copy Markdown

Summary

  • Updates (dora run --stop-after) help examples to use explicit duration units (30s, 5m, 1h)
  • Removes the bare-number example that could confuse users copying from help !

Fixes #2867

Test plan

  • Docs-only change in CLI help text
  • Optional: build CLI and check (dora run --help)

Use explicit unit suffixes in dora run --help so copied examples match the parser-friendly duration style.

Fixes dora-rs#2867.

Co-authored-by: Cursor <cursoragent@cursor.com>
@trunk-io

trunk-io Bot commented Aug 8, 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

@trunk-io

trunk-io Bot commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

An error occurred while submitting your PR to the queue: Only users that are a part of this repo's Trunk organization or have write permissions to the repo can submit a PR to the queue

phil-opp commented Aug 8, 2026

Copy link
Copy Markdown
Collaborator

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

Docs-only change, verified against the parser. parse_duration (binaries/cli/src/common.rs) delegates to duration_str::parse, and the existing tests confirm the new 1h example is valid (1h30m → 5400s is tested) and that the removed bare-number form (--stop-after 30) was itself a valid, tested input (bare numbers parse as seconds). So the removal is a help-text consistency choice rather than a correctness fix, and the updated examples are all accurate. No issues found.


Generated by Claude Code

phil-opp commented Aug 8, 2026

Copy link
Copy Markdown
Collaborator

Automated review by Claude (fully automated — no human has vetted this comment; please verify before acting).

I don't see why this change is needed as-is: it duplicates #2868, which edits the exact same --stop-after example block in binaries/cli/src/command/run.rs for the same issue (#2867). #2868 is further along and already went through review feedback.

More importantly, this PR removes the bare-number example (--stop-after 30 # 30 seconds). That form is a valid, supported input — parse_duration treats a bare number as seconds and it's test-pinned (parse_duration("15") == 15s in libraries/message/src/common.rs) — and #2868's reviewer specifically asked to keep it. Dropping it here re-introduces exactly the gap that PR's review settled, and the two will merge-conflict.

Suggest closing this in favor of #2868, or at minimum restoring the bare-number line. The remaining examples (30s/5m/1h) are all accurate.


Generated by Claude Code

@phil-opp

Copy link
Copy Markdown
Collaborator

Closing in favour of #2868, which covers the same ground more completely.

One correction worth recording: this PR removes --stop-after 30 # 30 seconds on the grounds that a bare number might confuse users, but a bare integer is accepted and is test-pinned at binaries/cli/src/common.rs (parse_duration("15") == Duration::from_secs(15)). Deleting it removed documentation of real, supported behaviour — it is the one form a user cannot infer from the others. #2868 documents all five accepted forms.

@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.

Update --stop-after examples to match accepted duration format

2 participants