Skip to content

Commit 15f17de

Browse files
giacomocavalierilpil
authored andcommitted
improve help text for run, test, and dev commands
1 parent 4a160dc commit 15f17de

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@
1010

1111
### Build tool
1212

13+
- The help text displayed by `gleam dev --help`, `gleam test --help`, and
14+
`gleam run --help` has been improved: now each one states which function it's
15+
going to run.
16+
([Giacomo Cavalieri](https://github.com/giacomocavalieri))
17+
1318
### Language server
1419

1520
- The "inline variable" code action can now trigger when used over the let

compiler-cli/src/lib.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,8 @@ enum Command {
215215
Shell,
216216

217217
/// Run the project
218+
///
219+
/// This command runs the `main` function from the `<PROJECT_NAME>` module.
218220
#[command(trailing_var_arg = true)]
219221
Run {
220222
#[arg(short, long, ignore_case = true, help = target_doc())]
@@ -235,6 +237,8 @@ enum Command {
235237
},
236238

237239
/// Run the project tests
240+
///
241+
/// This command runs the `main` function from the `<PROJECT_NAME>_test` module.
238242
#[command(trailing_var_arg = true)]
239243
Test {
240244
#[arg(short, long, ignore_case = true, help = target_doc())]
@@ -247,6 +251,8 @@ enum Command {
247251
},
248252

249253
/// Run the project development entrypoint
254+
///
255+
/// This command runs the `main` function from the `<PROJECT_NAME>_dev` module.
250256
#[command(trailing_var_arg = true)]
251257
Dev {
252258
#[arg(short, long, ignore_case = true, help = target_doc())]

0 commit comments

Comments
 (0)