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

unusual help documentation for pass-through flags #50

Open
matthewleon opened this issue Aug 5, 2017 · 0 comments
Open

unusual help documentation for pass-through flags #50

matthewleon opened this issue Aug 5, 2017 · 0 comments

Comments

@matthewleon
Copy link
Contributor

matthewleon commented Aug 5, 2017

example

$ psc-package build --help
Usage: psc-package build [-d|--only-dependencies] [`purs compile`-options]
  Build the current package and dependencies

Available options:
  -d,--only-dependencies   Compile only the package's dependencies
  `purs compile`-options   Options passed through to purs compile; use -- to
                           separate
  -h,--help                Show this help text

The documentation format for "purs-compile-options" seems to stray from UNIX command line norms. Ideally the usage line would more clearly illustrate the usage of -- to separate pass-through arguments.

Here is what stack does, for comparison:

$ stack exec --help
Usage: stack exec CMD [-- ARGS (e.g. stack ghc -- X.hs -o x)] ([--plain] |
                  [--[no-]ghc-package-path] [--[no-]stack-exe] [--package ARG]
                  [--rts-options RTSFLAG]) [--help]
  Execute a command
Rembane pushed a commit to Rembane/psc-package that referenced this issue May 26, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant