summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 2 insertions, 11 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.
235 235
236### `usage` 236### `usage`
237 237
238The `usage`, `usageEx` and `usageFull` are functions for printing a simple list of all parameters the 238The `usage`, `usageEx` and `usageFull` are functions for printing a small abbreviated version
239program can take. 239of the help message.
240 240
241```zig 241```zig
242const std = @import("std"); 242const std = @import("std");
@@ -266,12 +266,3 @@ pub fn main() !void {
266[-hv] [--value <N>] 266[-hv] [--value <N>]
267``` 267```
268 268
269The `usage` functions are the simplest to call. It only takes an `OutStream` and a slice of
270`Param(Help)`.
271
272The `usageEx` is the generic version of `usage`. It can print a usage message for any
273`Param` give that the caller provides functions for getting the usage and value strings.
274
275The `usageFull` is even more generic, allowing the functions that get the usage and value strings
276to return errors and take a context as a parameter.
277