summaryrefslogtreecommitdiff
path: root/README.md
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 /README.md
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--README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.md b/README.md
index 25199e2..56d41c7 100644
--- a/README.md
+++ b/README.md
@@ -217,9 +217,10 @@ pub fn main() !void {
217 var res = try clap.parse(clap.Help, &params, clap.parsers.default, .{}); 217 var res = try clap.parse(clap.Help, &params, clap.parsers.default, .{});
218 defer res.deinit(); 218 defer res.deinit();
219 219
220 // clap.help is a function that can print a simple help message, given a 220 // `clap.help` is a function that can print a simple help message. It can print any `Param`
221 // slice of Param(Help). There is also a helpEx, which can print a 221 // where `Id` has a `describtion` and `value` method (`Param(Help)` is one such parameter).
222 // help message for any Param, but it is more verbose to call. 222 // The last argument contains options as to how `help` should print those parameters. Using
223 // `.{}` means the default options.
223 if (res.args.help) 224 if (res.args.help)
224 return clap.help(std.io.getStdErr().writer(), clap.Help, &params, .{}); 225 return clap.help(std.io.getStdErr().writer(), clap.Help, &params, .{});
225} 226}
@@ -255,9 +256,8 @@ pub fn main() !void {
255 var res = try clap.parse(clap.Help, &params, clap.parsers.default, .{}); 256 var res = try clap.parse(clap.Help, &params, clap.parsers.default, .{});
256 defer res.deinit(); 257 defer res.deinit();
257 258
258 // clap.usage is a function that can print a simple usage message, given a 259 // `clap.usage` is a function that can print a simple help message. It can print any `Param`
259 // slice of Param(Help). There is also a usageEx, which can print a 260 // where `Id` has a `value` method (`Param(Help)` is one such parameter).
260 // usage message for any Param, but it is more verbose to call.
261 if (res.args.help) 261 if (res.args.help)
262 return clap.usage(std.io.getStdErr().writer(), clap.Help, &params); 262 return clap.usage(std.io.getStdErr().writer(), clap.Help, &params);
263} 263}