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

Some of the opa cli flag descriptions don't match the online documentation #2586

Closed
OmegaVVeapon opened this issue Jul 30, 2020 · 0 comments · Fixed by #2587
Closed

Some of the opa cli flag descriptions don't match the online documentation #2586

OmegaVVeapon opened this issue Jul 30, 2020 · 0 comments · Fixed by #2587

Comments

@OmegaVVeapon
Copy link
Contributor

Expected Behavior

Running opa eval --help should show similar descriptions to the descriptions show for those same flags in https://www.openpolicyagent.org/docs/latest/#2-try-opa-eval

Actual Behavior

The opa cli shows:

-d, --data string                                   set data file(s) or directory path(s)

for the data flag.

The online docs show:


--data | -d | Load policy or data files into OPA. This flag can be repeated.

Notice how the CLI description makes no mention that the policy needs to be loaded as data.

This can be confusing to newcomers to OPA (like me).

Steps to Reproduce the Problem

Self-explanatory.

Additional Info

Submitting a PR for this in a few minutes...

tsandall pushed a commit that referenced this issue Aug 6, 2020
- Changed the data flag description to specify that it can take policy
or data files
- Suffixed some descriptions with "This flag can be repeated." where
applicable

Fixes: #2586
Signed-off-by: Alan Silva <alansq16@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants