Skip to content

Commit fb9e62b

Browse files
committed
Update comments
1 parent 2918618 commit fb9e62b

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

splashsurf/src/cli.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,10 @@ impl Switch {
8383
/// Runs the splashsurf CLI with the provided command line arguments.
8484
///
8585
/// This function behaves like the binary `splashsurf` command line tool including output to stdout and stderr.
86-
/// Note that the first argument is always ignored as it is the binary name when called using `std::env::args()`
87-
/// from the command line:
86+
/// Note that the first argument is always ignored - this is typically the binary name when called using
87+
/// `std::env::args()` from the terminal:
8888
/// ```
89-
/// splashsurf::cli::run_splashsurf([".", "--version"]);
89+
/// splashsurf::cli::run_splashsurf(["splashsurf", "--version"]);
9090
/// ```
9191
/// If no placeholder for the binary name is provided it will return an error (and print a help message):
9292
/// ```should_panic

0 commit comments

Comments
 (0)