summaryrefslogtreecommitdiff
path: root/example/help.zig
diff options
context:
space:
mode:
authorGravatar Jimmi Holst Christensen2022-03-30 22:04:15 +0200
committerGravatar Jimmi Holst Christensen2022-03-30 22:04:15 +0200
commitac5f46541ca47d3db9df0fcef3cc61731adaefab (patch)
tree6fde8d5846540eaa63f6f11bd9527c8fecdb441b /example/help.zig
parentNew `help` api that provides options as to how paramters are printed. (diff)
downloadzig-clap-ac5f46541ca47d3db9df0fcef3cc61731adaefab.tar.gz
zig-clap-ac5f46541ca47d3db9df0fcef3cc61731adaefab.tar.xz
zig-clap-ac5f46541ca47d3db9df0fcef3cc61731adaefab.zip
Update help and usage examples
Diffstat (limited to 'example/help.zig')
-rw-r--r--example/help.zig7
1 files changed, 4 insertions, 3 deletions
diff --git a/example/help.zig b/example/help.zig
index 18d61b9..dd9c9ea 100644
--- a/example/help.zig
+++ b/example/help.zig
@@ -11,9 +11,10 @@ pub fn main() !void {
11 var res = try clap.parse(clap.Help, &params, clap.parsers.default, .{}); 11 var res = try clap.parse(clap.Help, &params, clap.parsers.default, .{});
12 defer res.deinit(); 12 defer res.deinit();
13 13
14 // clap.help is a function that can print a simple help message, given a 14 // `clap.help` is a function that can print a simple help message. It can print any `Param`
15 // slice of Param(Help). There is also a helpEx, which can print a 15 // where `Id` has a `describtion` and `value` method (`Param(Help)` is one such parameter).
16 // help message for any Param, but it is more verbose to call. 16 // The last argument contains options as to how `help` should print those parameters. Using
17 // `.{}` means the default options.
17 if (res.args.help) 18 if (res.args.help)
18 return clap.help(std.io.getStdErr().writer(), clap.Help, &params, .{}); 19 return clap.help(std.io.getStdErr().writer(), clap.Help, &params, .{});
19} 20}