summaryrefslogtreecommitdiff
path: root/example/usage.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/usage.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 '')
-rw-r--r--example/usage.zig5
1 files changed, 2 insertions, 3 deletions
diff --git a/example/usage.zig b/example/usage.zig
index f57b07c..0d21352 100644
--- a/example/usage.zig
+++ b/example/usage.zig
@@ -12,9 +12,8 @@ pub fn main() !void {
12 var res = try clap.parse(clap.Help, &params, clap.parsers.default, .{}); 12 var res = try clap.parse(clap.Help, &params, clap.parsers.default, .{});
13 defer res.deinit(); 13 defer res.deinit();
14 14
15 // clap.usage is a function that can print a simple usage message, given a 15 // `clap.usage` is a function that can print a simple help message. It can print any `Param`
16 // slice of Param(Help). There is also a usageEx, which can print a 16 // where `Id` has a `value` method (`Param(Help)` is one such parameter).
17 // usage message for any Param, but it is more verbose to call.
18 if (res.args.help) 17 if (res.args.help)
19 return clap.usage(std.io.getStdErr().writer(), clap.Help, &params); 18 return clap.usage(std.io.getStdErr().writer(), clap.Help, &params);
20} 19}