Skip to content

Update USAGE.md w/more clear relaunch instructions#536

Merged
jordeu merged 4 commits into
masterfrom
ad_relaunch
May 21, 2026
Merged

Update USAGE.md w/more clear relaunch instructions#536
jordeu merged 4 commits into
masterfrom
ad_relaunch

Conversation

@andrew-dawson-seqera
Copy link
Copy Markdown
Contributor

No description provided.

Copy link
Copy Markdown
Member

@robnewman robnewman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixing syntax and align with other examples

Comment thread USAGE.md Outdated
Copy link
Copy Markdown
Member

@robnewman robnewman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved subject to very minor changes being incorporated.

Comment thread USAGE.md
Run `tw runs relaunch -h` to view all the required and optional fields for relaunching a run in a workspace.

In the example below, we relaunch a run with ID `3S3KzAasBa4Bt3` in workspace `my-workspace`:
```console
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```console
```console

Comment thread USAGE.md
In the example below, we relaunch a run with ID `3S3KzAasBa4Bt3` in workspace `my-workspace`:
```console
tw runs relaunch -i 3S3KzAasBa4Bt3 -w my-workspace

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe you need a trailing ``` and newline to cleanly close off the console code block.

andrew-dawson-seqera and others added 3 commits May 21, 2026 17:01
Co-authored-by: Rob Newman <61608+robnewman@users.noreply.github.com>
Without the closing ``` fence, the rest of USAGE.md from "### Cancel a
run" onward was rendered as code. Adds the missing fence and prefixes
the example with $ to match the convention used elsewhere in the file.
- MD031: add blank line before the fenced code block
- MD014: drop the $ prefix since the example doesn't show output
@jordeu jordeu merged commit f5799c7 into master May 21, 2026
16 checks passed
@jordeu jordeu mentioned this pull request May 22, 2026
2 tasks
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.

3 participants