Skip to content

Commit e7b5cab

Browse files
committed
docs: document design
1 parent 335b513 commit e7b5cab

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,8 @@ const { flags, values, positionals } = parseArgs(argv, options);
195195
- Does the API specify whether a `--` was present/relevant?
196196
- no
197197
- Is `-foo` the same as `--foo`?
198-
- no, `-foo` is a short option or options (WIP: https://github.com/pkgjs/parseargs/issues/2)
198+
- no, `-foo` is a short option or options, with expansion logic that follows the
199+
[Utility Syntax Guidelines in POSIX.1-2017](https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html). `--foo bar`, `withValue: ['foo']`, expands to `-f`, `-o`, `-o bar`.
199200
- Is `---foo` the same as `--foo`?
200201
- no
201202
- the first flag would be parsed as `'-foo'`

0 commit comments

Comments
 (0)