Final improvements

This commit is contained in:
Andrew Morozko 2019-11-30 22:31:08 +03:00
parent c49d847704
commit 9d4521ce8b
2 changed files with 29 additions and 27 deletions

View File

@ -148,32 +148,6 @@ var args struct {
arg.MustParse(&args) arg.MustParse(&args)
``` ```
### Custom placeholders
```go
var args struct {
Input string `arg:"positional" placeholder:"SRC"`
Output []string `arg:"positional" placeholder:"DST"`
Optimize int `arg:"-O" help:"optimization level" placeholder:"LEVEL"`
MaxJobs int `arg:"-j" help:"maximum number of simultaneous jobs" placeholder:"N"`
}
arg.MustParse(&args)
```
```shell
$ ./example -h
Usage: example [--optimize LEVEL] [--maxjobs N] SRC [DST [DST ...]]
Positional arguments:
SRC
DST
Options:
--optimize LEVEL, -O LEVEL
optimization level
--maxjobs N, -j N maximum number of simultaneous jobs
--help, -h display this help and exit
```
### Default values (before v1.2) ### Default values (before v1.2)
```go ```go
@ -361,6 +335,34 @@ $ ./example
main.NameDotName{Head:"file", Tail:"txt"} main.NameDotName{Head:"file", Tail:"txt"}
``` ```
### Custom placeholders
Use the `placeholder` tag to control which placeholder text is used in the usage text.
```go
var args struct {
Input string `arg:"positional" placeholder:"SRC"`
Output []string `arg:"positional" placeholder:"DST"`
Optimize int `arg:"-O" help:"optimization level" placeholder:"LEVEL"`
MaxJobs int `arg:"-j" help:"maximum number of simultaneous jobs" placeholder:"N"`
}
arg.MustParse(&args)
```
```shell
$ ./example -h
Usage: example [--optimize LEVEL] [--maxjobs N] SRC [DST [DST ...]]
Positional arguments:
SRC
DST
Options:
--optimize LEVEL, -O LEVEL
optimization level
--maxjobs N, -j N maximum number of simultaneous jobs
--help, -h display this help and exit
```
### Description strings ### Description strings
```go ```go

View File

@ -136,7 +136,7 @@ func Example_helpText() {
} }
// This example shows the usage string generated by go-arg with customized placeholders // This example shows the usage string generated by go-arg with customized placeholders
func Example_helpDataname() { func Example_helpPlaceholder() {
// These are the args you would pass in on the command line // These are the args you would pass in on the command line
os.Args = split("./example --help") os.Args = split("./example --help")