Skip to content

Commit eeb6f99

Browse files
authored
docs: document @arg.{positional,noDefaultName} (#185)
closes #184
1 parent fd4dfd6 commit eeb6f99

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

readme.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -413,6 +413,11 @@ customize your usage:
413413
- `doc: String`: a documentation string used to provide additional information
414414
about the command
415415

416+
- `noDefaultName: Boolean`: if `true` this arg (e.g `fooBar`) can only be called by its mangled name `--foo-bar` and not by the original name `--fooBar`. Defaults to `false`
417+
418+
- `positional: Boolean`: if `true` this arg can be passed "positionally" without
419+
the `--name` of the parameter being provided, e.g. `./mill example.hello hello 3 --bool`. Defaults to `false`
420+
416421
- `hidden: Boolean`: if `true` this arg will not be included in the rendered help text.
417422

418423
## Customization

0 commit comments

Comments
 (0)