aboutsummaryrefslogtreecommitdiff
path: root/mingling_core/src/program/config.rs
diff options
context:
space:
mode:
Diffstat (limited to 'mingling_core/src/program/config.rs')
-rw-r--r--mingling_core/src/program/config.rs12
1 files changed, 10 insertions, 2 deletions
diff --git a/mingling_core/src/program/config.rs b/mingling_core/src/program/config.rs
index 6d54a4e..c5f91da 100644
--- a/mingling_core/src/program/config.rs
+++ b/mingling_core/src/program/config.rs
@@ -42,13 +42,21 @@ pub struct ProgramStdoutSetting {
pub clap_help_print_behaviour: ClapHelpPrintBehaviour,
}
+/// Behavior when Clap Dispatcher outputs help information
#[cfg(feature = "clap")]
#[derive(Debug, Default, Clone)]
pub enum ClapHelpPrintBehaviour {
- /// Write to RenderResult
+ /// Write help information to `RenderResult` instead of printing to stdout directly.
+ ///
+ /// This allows the help text to be captured and processed as part of the program's
+ /// structured output, which is useful when integrating with external tools or
+ /// when the output needs to be further transformed.
WriteToRenderResult,
- /// Print directly
+ /// Print help information directly to stdout.
+ ///
+ /// This is the default behavior, which prints help text immediately to the terminal
+ /// without any intermediate processing or capture.
#[default]
PrintDirectly,
}