summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Jimmi Holst Christensen2025-07-22 10:49:49 +0200
committerGravatar Jimmi Holst Christensen2025-07-22 10:49:49 +0200
commit1c8cc16b660d8933c48b1f8c5321542985c92c04 (patch)
tree16260ac3cbc89cadefbb713fc554289032b6ed2c /README.md
parentfeat: Add `Diagnostic.reportToFile` (diff)
downloadzig-clap-1c8cc16b660d8933c48b1f8c5321542985c92c04.tar.gz
zig-clap-1c8cc16b660d8933c48b1f8c5321542985c92c04.tar.xz
zig-clap-1c8cc16b660d8933c48b1f8c5321542985c92c04.zip
feat: Add `clap.helpToFile`
The code for printing help became quite verbose after writegate. Writing help to a file like stdout and stderr is very common, so this wrapper provides a default, buffered way to report to a file.
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 2 insertions, 6 deletions
diff --git a/README.md b/README.md
index 8db67c9..6a1435f 100644
--- a/README.md
+++ b/README.md
@@ -365,12 +365,8 @@ pub fn main() !void {
365 // where `Id` has a `description` and `value` method (`Param(Help)` is one such parameter). 365 // where `Id` has a `description` and `value` method (`Param(Help)` is one such parameter).
366 // The last argument contains options as to how `help` should print those parameters. Using 366 // The last argument contains options as to how `help` should print those parameters. Using
367 // `.{}` means the default options. 367 // `.{}` means the default options.
368 if (res.args.help != 0) { 368 if (res.args.help != 0)
369 var buf: [1024]u8 = undefined; 369 return clap.helpToFile(.stderr(), clap.Help, &params, .{});
370 var stderr = std.fs.File.stderr().writer(&buf);
371 try clap.help(&stderr.interface, clap.Help, &params, .{});
372 return stderr.interface.flush();
373 }
374} 370}
375 371
376const clap = @import("clap"); 372const clap = @import("clap");