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

Misleading documentation of --init #537

Closed
TysonAndre opened this issue Feb 23, 2018 · 1 comment
Closed

Misleading documentation of --init #537

TysonAndre opened this issue Feb 23, 2018 · 1 comment
Labels

Comments

@TysonAndre
Copy link
Contributor

An actual example is vendor/bin/psalm --init script 1

There's no --level flag. [level=3] would be clearer. Including the value of the level in the error message would make it clearer that level= shouldn't be part of the CLI invocation. (Or mentioning an example invocation)

  • Another possible approach would be to a --level/--init-level flag? If more flags for init get added, providing an un-named list would get unwieldly.
  • As an example, a user might want to provide multiple source directories?

The current help text:

    -i, --init [source_dir=src] [--level=3]
        Create a psalm config file in the current directory that points to [source_dir]
        at the required level, from 1, most strict, to 6, most permissive
@muglug muglug added the bug label Feb 27, 2018
@muglug muglug closed this as completed in 2cec81e Mar 2, 2018
@muglug
Copy link
Collaborator

muglug commented Mar 2, 2018

Thanks!

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

No branches or pull requests

2 participants