diff options
Diffstat (limited to 'example/README.md.template')
| -rw-r--r-- | example/README.md.template | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/example/README.md.template b/example/README.md.template index 1fd90b0..d1d45e5 100644 --- a/example/README.md.template +++ b/example/README.md.template | |||
| @@ -87,3 +87,26 @@ The `helpEx` is the generic version of `help`. It can print a help message for a | |||
| 87 | 87 | ||
| 88 | The `helpFull` is even more generic, allowing the functions that get the help and value strings | 88 | The `helpFull` is even more generic, allowing the functions that get the help and value strings |
| 89 | to return errors and take a context as a parameter. | 89 | to return errors and take a context as a parameter. |
| 90 | |||
| 91 | ### `usage` | ||
| 92 | |||
| 93 | The `usage`, `usageEx` and `usageFull` are functions for printing a simple list of all parameters the | ||
| 94 | program can take. | ||
| 95 | |||
| 96 | ```zig | ||
| 97 | {} | ||
| 98 | ``` | ||
| 99 | |||
| 100 | ``` | ||
| 101 | [-hv] [--value <N>] | ||
| 102 | ``` | ||
| 103 | |||
| 104 | The `usage` functions are the simplest to call. It only takes an `OutStream` and a slice of | ||
| 105 | `Param(Help)`. | ||
| 106 | |||
| 107 | The `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 | |||
| 110 | The `usageFull` is even more generic, allowing the functions that get the usage and value strings | ||
| 111 | to return errors and take a context as a parameter. | ||
| 112 | |||