From b2059e5d086731a37f5988bfc6bfdb0848f14ece Mon Sep 17 00:00:00 2001
From: Jimmi Holst Christensen
Date: Mon, 29 Nov 2021 17:01:36 +0100
Subject: 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
---
 example/help.zig | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

(limited to 'example/help.zig')

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");
 const std = @import("std");
 
 pub fn main() !void {
+    const params = comptime [_]clap.Param(clap.Help){
+        clap.parseParam("-h, --help     Display this help and exit.         ") catch unreachable,
+        clap.parseParam("-v, --version  Output version information and exit.") catch unreachable,
+    };
+
+    var args = try clap.parse(clap.Help, &params, .{});
+    defer args.deinit();
+
     // clap.help is a function that can print a simple help message, given a
     // slice of Param(Help). There is also a helpEx, which can print a
     // help message for any Param, but it is more verbose to call.
-    try clap.help(
-        std.io.getStdErr().writer(),
-        comptime &.{
-            clap.parseParam("-h, --help     Display this help and exit.         ") catch unreachable,
-            clap.parseParam("-v, --version  Output version information and exit.") catch unreachable,
-        },
-    );
+    if (args.flag("--help"))
+        return clap.help(std.io.getStdErr().writer(), &params);
 }
-- 
cgit v1.2.3