From ca4b720d1b99f217559fe52d2be2146514d406a3 Mon Sep 17 00:00:00 2001 From: Jimmi Holst Christensen Date: Thu, 5 Mar 2020 23:28:11 +0100 Subject: Better readme for usage --- README.md | 13 ++----------- example/README.md.template | 13 ++----------- 2 files changed, 4 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 47c028d..12d691d 100644 --- a/README.md +++ b/README.md @@ -235,8 +235,8 @@ to return errors and take a context as a parameter. ### `usage` -The `usage`, `usageEx` and `usageFull` are functions for printing a simple list of all parameters the -program can take. +The `usage`, `usageEx` and `usageFull` are functions for printing a small abbreviated version +of the help message. ```zig const std = @import("std"); @@ -266,12 +266,3 @@ pub fn main() !void { [-hv] [--value ] ``` -The `usage` functions are the simplest to call. It only takes an `OutStream` and a slice of -`Param(Help)`. - -The `usageEx` is the generic version of `usage`. It can print a usage message for any -`Param` give that the caller provides functions for getting the usage and value strings. - -The `usageFull` is even more generic, allowing the functions that get the usage and value strings -to return errors and take a context as a parameter. - diff --git a/example/README.md.template b/example/README.md.template index d1d45e5..5e75d5d 100644 --- a/example/README.md.template +++ b/example/README.md.template @@ -90,8 +90,8 @@ to return errors and take a context as a parameter. ### `usage` -The `usage`, `usageEx` and `usageFull` are functions for printing a simple list of all parameters the -program can take. +The `usage`, `usageEx` and `usageFull` are functions for printing a small abbreviated version +of the help message. ```zig {} @@ -101,12 +101,3 @@ program can take. [-hv] [--value ] ``` -The `usage` functions are the simplest to call. It only takes an `OutStream` and a slice of -`Param(Help)`. - -The `usageEx` is the generic version of `usage`. It can print a usage message for any -`Param` give that the caller provides functions for getting the usage and value strings. - -The `usageFull` is even more generic, allowing the functions that get the usage and value strings -to return errors and take a context as a parameter. - -- cgit v1.2.3