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

Add better docs for new options system #247

Open
joshheinrichs-shopify opened this issue Jun 14, 2022 · 0 comments
Open

Add better docs for new options system #247

joshheinrichs-shopify opened this issue Jun 14, 2022 · 0 comments

Comments

@joshheinrichs-shopify
Copy link
Contributor

joshheinrichs-shopify commented Jun 14, 2022

We don't have much in the way of docs covering the new option system. There are many things in https://github.com/Shopify/cli-kit/blob/main/lib/cli/kit/opts.rb that should probably be covered, e.g.

  • option
  • multi_option
  • position
  • rest
  • skippable positions
  • callable defaults
  • ...

Additionally, it would be good to include useful patterns such the --no-<multi_option> flag to zero a multi_option default described in #246

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant