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

Wrong command syntax '--sort-by-required' #55

Open
chakatz opened this issue Nov 10, 2022 · 1 comment
Open

Wrong command syntax '--sort-by-required' #55

chakatz opened this issue Nov 10, 2022 · 1 comment
Assignees

Comments

@chakatz
Copy link

chakatz commented Nov 10, 2022

I'm a first-time user, but it seems to me that
--sort-by-required should be --sort-by required
It is wrong in several places in the readme.

https://github.com/cytopia/docker-terraform-docs/blob/master/README.md

I ran the command below to figure out the proper syntax
docker run --rm -v $(pwd):/data cytopia/terraform-docs terraform-docs help

@cytopia
Copy link
Owner

cytopia commented Nov 10, 2022

Good point. This is a relict from older versions when arguments where named differently. I will make it a PR to clean up the legacy commands.

@cytopia cytopia self-assigned this Nov 10, 2022
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

2 participants