Skip to content

cargo ci self-docs uses doc comments as well as explicit helptext #4860

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bfops wants to merge 2 commits into from
+14 −7
Open

cargo ci self-docs uses doc comments as well as explicit helptext #4860

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
afe3fd1
[bfops/ci-helptext]: CI helptext
bfops Apr 21, 2026
1c9d9b2
[bfops/ci-helptext]: WIP
bfops Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions tools/ci/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Usage: smoketests [OPTIONS] [ARGS]... [COMMAND]
When specified, tests will connect to the given URL instead of starting local server instances. Tests that require local server control (like restart tests) will be skipped.

- `--dotnet`:
- `args`:
- `args`: Additional arguments to pass to the test runner
- `--help`: Print help (see a summary with '-h')

#### `prepare`
Expand All @@ -130,7 +130,7 @@ Usage: check-mod-list

**Options:**

- `--help`:
- `--help`: Print help

#### `help`

Expand All @@ -141,7 +141,7 @@ Usage: help [COMMAND]...

**Options:**

- `subcommand`:
- `subcommand`: Print help for the subcommand(s)

### `update-flow`

Expand Down Expand Up @@ -193,7 +193,7 @@ Usage: global-json-policy

**Options:**

- `--help`:
- `--help`: Print help

### `help`

Expand All @@ -204,7 +204,7 @@ Usage: help [COMMAND]...

**Options:**

- `subcommand`:
- `subcommand`: Print help for the subcommand(s)


---
Expand Down
11 changes: 9 additions & 2 deletions tools/ci/src/ci_docs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,19 @@ fn generate_markdown(cmd: &mut Command, heading_level: usize) -> String {
.map(|l| format!("--{}", l))
.or_else(|| arg.get_short().map(|s| format!("-{}", s)))
.unwrap_or_else(|| arg.get_id().to_string());
let help = arg.get_long_help().unwrap_or_default();
let help = arg
.get_long_help()
.or_else(|| arg.get_help())
.map(|help| help.to_string())
.unwrap_or_else(|| {
eprintln!("Warning: argument `{}` is missing help text", arg.get_id());
"".to_string()
});
options.push_str(&format!(
"- `{}`: {}\n{}",
names,
help,
if help.to_string().lines().count() > 1 { "\n" } else { "" }
if help.lines().count() > 1 { "\n" } else { "" }
));
}

Expand Down
Loading