Update examples

prajwalch · Sep 23, 2022 · 2b8a488 · 2b8a488
1 parent a9a056a
commit 2b8a488
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 16 deletions.
diff --git a/examples/git.zig b/examples/git.zig
@@ -3,7 +3,6 @@ const yazap = @import("yazap");
 
 const allocator = std.heap.page_allocator;
 const flag = yazap.flag;
-const Command = yazap.Command;
 const Arg = yazap.Arg;
 const Yazap = yazap.Yazap;
 
@@ -13,24 +12,24 @@ const Yazap = yazap.Yazap;
 // git push <remote> <branch_name>
 
 pub fn main() anyerror!void {
-    var app = Yazap.init(allocator, "mygit");
+    var app = Yazap.init(allocator, "mygit", null);
     defer app.deinit();
 
     var git = app.rootCommand();
 
-    var cmd_commit = app.createCommand("commit");
-    try cmd_commit.addArg(flag.argOne("message", 'm'));
+    var cmd_commit = app.createCommand("commit", "Record changes to the repository");
+    try cmd_commit.addArg(flag.argOne("message", 'm', "commit message"));
 
-    var cmd_pull = app.createCommand("pull");
+    var cmd_pull = app.createCommand("pull", "Fetch from remote branch and merge it to local");
     try cmd_pull.takesSingleValue("REMOTE");
     cmd_pull.argRequired(true);
 
-    var cmd_push = app.createCommand("push");
+    var cmd_push = app.createCommand("push", "Update the remote branch");
     try cmd_push.takesSingleValue("REMOTE");
     try cmd_push.takesSingleValue("BRANCH_NAME");
     cmd_push.argRequired(true);
 
-    try git.addSubcommand(app.createCommand("init"));
+    try git.addSubcommand(app.createCommand("init", "Create an empty Git repository or reinitialize an existing one"));
     try git.addSubcommand(cmd_commit);
     try git.addSubcommand(cmd_pull);
     try git.addSubcommand(cmd_push);

diff --git a/examples/touch.zig b/examples/touch.zig
@@ -7,25 +7,19 @@ const Command = yazap.Command;
 const Yazap = yazap.Yazap;
 
 pub fn main() anyerror!void {
-    var app = Yazap.init(allocator, "mytouch");
+    var app = Yazap.init(allocator, "mytouch", null);
     defer app.deinit();
 
     var touch = app.rootCommand();
 
     try touch.takesSingleValue("FILE_NAME");
     touch.argRequired(true);
 
-    try touch.addArg(flag.boolean("no-create", 'c'));
-    try touch.addArg(flag.boolean("version", 'v'));
-    try touch.addArg(flag.boolean("help", 'h'));
+    try touch.addArg(flag.boolean("no-create", 'c', "Do not create any files"));
+    try touch.addArg(flag.boolean("version", 'v', "Display app version"));
 
     var args = try app.parseProcess();
 
-    if (args.isPresent("help")) {
-        std.debug.print("Show help", .{});
-        return;
-    }
-
     if (args.isPresent("version")) {
         std.debug.print("v0.1.0", .{});
         return;