Skip to content

docs: document table default for multi-value options in cli:option docstring #83

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.

Sign up for GitHub

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

Open
Copilot wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: document table default for multi-value options in cli:option docstring #83

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/cliargs/core.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,11 +400,17 @@ local function create_core()
---
--- A description for the argument to be shown in --help.
---
--- @param {bool} [default=nil]
--- @param {string|table} [default=nil]
---
--- A default value to use in case the option was not specified at
--- run-time (the default value is nil if you leave this blank.)
---
--- If you pass a **table** (e.g. `{}` or `{ "value1" }`), the
--- option will accept multiple values: each invocation of the flag
--- appends the supplied value to that table. The pre-populated
--- table entries serve as the default list when the option is never
--- supplied on the command-line.
---
--- @param {function} [callback]
---
--- A callback to invoke when this option is parsed.
Expand Down
Loading