summaryrefslogtreecommitdiff
path: root/example
diff options
context:
space:
mode:
authorGravatar Jimmi Holst Christensen2020-03-05 23:28:11 +0100
committerGravatar Jimmi Holst Christensen2020-03-05 23:28:11 +0100
commitca4b720d1b99f217559fe52d2be2146514d406a3 (patch)
tree1eaa42e4a1d62023a529ced937720f72157763f2 /example
parentAdd clap.usage (diff)
downloadzig-clap-ca4b720d1b99f217559fe52d2be2146514d406a3.tar.gz
zig-clap-ca4b720d1b99f217559fe52d2be2146514d406a3.tar.xz
zig-clap-ca4b720d1b99f217559fe52d2be2146514d406a3.zip
Better readme for usage
Diffstat (limited to 'example')
-rw-r--r--example/README.md.template13
1 files changed, 2 insertions, 11 deletions
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.
90 90
91### `usage` 91### `usage`
92 92
93The `usage`, `usageEx` and `usageFull` are functions for printing a simple list of all parameters the 93The `usage`, `usageEx` and `usageFull` are functions for printing a small abbreviated version
94program can take. 94of the help message.
95 95
96```zig 96```zig
97{} 97{}
@@ -101,12 +101,3 @@ program can take.
101[-hv] [--value <N>] 101[-hv] [--value <N>]
102``` 102```
103 103
104The `usage` functions are the simplest to call. It only takes an `OutStream` and a slice of
105`Param(Help)`.
106
107The `usageEx` is the generic version of `usage`. It can print a usage message for any
108`Param` give that the caller provides functions for getting the usage and value strings.
109
110The `usageFull` is even more generic, allowing the functions that get the usage and value strings
111to return errors and take a context as a parameter.
112