summaryrefslogtreecommitdiff
path: root/example/help.zig
diff options
context:
space:
mode:
authorGravatar Jimmi Holst Christensen2021-11-29 17:01:36 +0100
committerGravatar Komari Spaghetti2021-11-29 17:09:26 +0100
commitb2059e5d086731a37f5988bfc6bfdb0848f14ece (patch)
treec2ebf7806f383f18ebc7253bbe9e6e9da2db39d4 /example/help.zig
parentFix chaining typo (diff)
downloadzig-clap-b2059e5d086731a37f5988bfc6bfdb0848f14ece.tar.gz
zig-clap-b2059e5d086731a37f5988bfc6bfdb0848f14ece.tar.xz
zig-clap-b2059e5d086731a37f5988bfc6bfdb0848f14ece.zip
Improve help and usage examples
Instead of just calling these function, have the examples be small programs that demonstrates how you would actually use them together with argument parsing. fixes #57
Diffstat (limited to 'example/help.zig')
-rw-r--r--example/help.zig17
1 files changed, 10 insertions, 7 deletions
diff --git a/example/help.zig b/example/help.zig
index d90373a..de3b707 100644
--- a/example/help.zig
+++ b/example/help.zig
@@ -2,14 +2,17 @@ const clap = @import("clap");
2const std = @import("std"); 2const std = @import("std");
3 3
4pub fn main() !void { 4pub fn main() !void {
5 const params = comptime [_]clap.Param(clap.Help){
6 clap.parseParam("-h, --help Display this help and exit. ") catch unreachable,
7 clap.parseParam("-v, --version Output version information and exit.") catch unreachable,
8 };
9
10 var args = try clap.parse(clap.Help, &params, .{});
11 defer args.deinit();
12
5 // clap.help is a function that can print a simple help message, given a 13 // clap.help is a function that can print a simple help message, given a
6 // slice of Param(Help). There is also a helpEx, which can print a 14 // slice of Param(Help). There is also a helpEx, which can print a
7 // help message for any Param, but it is more verbose to call. 15 // help message for any Param, but it is more verbose to call.
8 try clap.help( 16 if (args.flag("--help"))
9 std.io.getStdErr().writer(), 17 return clap.help(std.io.getStdErr().writer(), &params);
10 comptime &.{
11 clap.parseParam("-h, --help Display this help and exit. ") catch unreachable,
12 clap.parseParam("-v, --version Output version information and exit.") catch unreachable,
13 },
14 );
15} 18}