diff options
| author | 2021-11-29 17:01:36 +0100 | |
|---|---|---|
| committer | 2021-11-29 17:09:26 +0100 | |
| commit | b2059e5d086731a37f5988bfc6bfdb0848f14ece (patch) | |
| tree | c2ebf7806f383f18ebc7253bbe9e6e9da2db39d4 /example/usage.zig | |
| parent | Fix chaining typo (diff) | |
| download | zig-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/usage.zig')
| -rw-r--r-- | example/usage.zig | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/example/usage.zig b/example/usage.zig index 90fa310..368a6b3 100644 --- a/example/usage.zig +++ b/example/usage.zig | |||
| @@ -2,15 +2,18 @@ const clap = @import("clap"); | |||
| 2 | const std = @import("std"); | 2 | const std = @import("std"); |
| 3 | 3 | ||
| 4 | pub fn main() !void { | 4 | pub 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 | clap.parseParam(" --value <N> An option parameter, which takes a value.") catch unreachable, | ||
| 9 | }; | ||
| 10 | |||
| 11 | var args = try clap.parse(clap.Help, ¶ms, .{}); | ||
| 12 | defer args.deinit(); | ||
| 13 | |||
| 5 | // clap.usage is a function that can print a simple usage message, given a | 14 | // clap.usage is a function that can print a simple usage message, given a |
| 6 | // slice of Param(Help). There is also a usageEx, which can print a | 15 | // slice of Param(Help). There is also a usageEx, which can print a |
| 7 | // usage message for any Param, but it is more verbose to call. | 16 | // usage message for any Param, but it is more verbose to call. |
| 8 | try clap.usage( | 17 | if (args.flag("--help")) |
| 9 | std.io.getStdErr().writer(), | 18 | return clap.usage(std.io.getStdErr().writer(), ¶ms); |
| 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 | clap.parseParam(" --value <N> An option parameter, which takes a value.") catch unreachable, | ||
| 14 | }, | ||
| 15 | ); | ||
| 16 | } | 19 | } |