Skip to content

Commit 2be036e

Browse files
committed
docs: Add doc comments for clap command handler functions
1 parent 943d7bc commit 2be036e

File tree

3 files changed

+3
-0
lines changed

3 files changed

+3
-0
lines changed

rust/boil/src/build/mod.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ pub enum Error {
4141
InvalidImageVersion,
4242
}
4343

44+
/// This is the `boil build` command handler function.
4445
pub fn run_command(args: BuildArguments, config: Config) -> Result<(), Error> {
4546
// TODO (@Techassi): Parse Dockerfile instead to build the target graph
4647
// Validation

rust/boil/src/completions/mod.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ pub struct CompletionsArguments {
99
pub shell: Shell,
1010
}
1111

12+
/// This is the `boil completions` command handler function.
1213
pub fn run_command(arguments: CompletionsArguments) {
1314
let mut cli = Cli::command();
1415
let bin_name = cli.get_bin_name().unwrap_or("boil").to_owned();

rust/boil/src/show/images/mod.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ impl Serialize for OneOrMany {
4343
}
4444
}
4545

46+
/// This is the `boil show images` command handler function.
4647
pub fn run_command(arguments: ShowImagesArguments) -> Result<(), Error> {
4748
let list: BTreeMap<_, _> = if arguments.image.is_empty() {
4849
Targets::all(TargetsOptions { only_entry: true })

0 commit comments

Comments
 (0)