summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRick <[email protected]>2017-10-02 14:36:23 +0100
committerRick <[email protected]>2017-10-02 14:36:23 +0100
commitba9514f0be00c17e53b4e0e255bcb9482354935f (patch)
treef0814a6cf76ebae438a0d827466c853c913b8b3f /README.md
parentd7961941f0ceee4e55062041991de7bbd43b2b57 (diff)
Further clarification
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/README.md b/README.md
index 18e572d..18dc556 100644
--- a/README.md
+++ b/README.md
@@ -122,6 +122,9 @@ Options:
--help, -h print this help message
```
+As the example above shows, the `help` tag can be used in conjunction with `arg`, or instead. When used
+together, they can appear in either order.
+
### Default values
```go
@@ -322,4 +325,4 @@ The main idea behind `go-arg` is that Go already has an excellent way to describ
### Backward Compatibility Notes
-The tags have changed recently. Earlier versions required the help text to be part of the `arg` tag. This is still supported but is now deprecated. Instead, you should use a separate `help` tag, described above, which removes most of the limits on the text you can write.
+The tags have changed recently. Earlier versions required the help text to be part of the `arg` tag. This is still supported but is now deprecated. Instead, you should use a separate `help` tag, described above, which removes most of the limits on the text you can write. In particular, you will need to use the new `help` tag if your help text includes any commas.