Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise argument terminology? #1344

Closed
shadowspawn opened this issue Sep 5, 2020 · 1 comment
Closed

Revise argument terminology? #1344

shadowspawn opened this issue Sep 5, 2020 · 1 comment
Assignees
Labels
docs README (or other docs) could be improved

Comments

@shadowspawn
Copy link
Collaborator

shadowspawn commented Sep 5, 2020

While working on #1315 and #1332 I did a rethink of the terminology for talking about arguments, expecially options and option-arguments. Pretty happy with how it worked out in that content, and considering rewriting README to match.

Some background research is in #1332 (comment)


Terminology

The command line arguments are made up of options, option-arguments, commands, and command-arguments.

Term Explanation
option an argument which is a - followed by a character, or -- followed by a word (or hyphenated words), like -s or --short
option-argument some options can take an argument
command a program or command can have subcommands
command-argument argument for the command (and not an option or option-argument)

For example:

my-utility command --option option-argument command-argument-1 command-argument-2

In other references options are sometimes called flags, and command-arguments are sometimes called positional arguments or operands.

@shadowspawn shadowspawn added the docs README (or other docs) could be improved label Sep 5, 2020
@shadowspawn shadowspawn changed the title Revise argument terminology Revise argument terminology? Sep 7, 2020
@shadowspawn shadowspawn self-assigned this Sep 13, 2020
@shadowspawn shadowspawn added the pending release Merged into a branch for a future release, but not released yet label Sep 26, 2020
@shadowspawn shadowspawn removed the pending release Merged into a branch for a future release, but not released yet label Oct 25, 2020
@shadowspawn
Copy link
Collaborator Author

Released in Commander v6.2.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs README (or other docs) could be improved
Projects
None yet
Development

No branches or pull requests

1 participant