search

hashicorp-community / tf-helper

Commands for performing operations on Terraform states, configurations, TFE using the API, and more. Please target all PRs to the master branch, not the release branch.
Mozilla Public License 2.0
102 stars 32 forks source link

Minor documentation updates #23

Closed carbonrobot closed 4 years ago

carbonrobot commented 4 years ago

Updates the docs to correctly reflect the usage of the tfh global parameters and the tfh pushconfig command.

fprimex commented 4 years ago

The docs are written the way that they are because the subcommands, parameters, and options come directly from them. They are parsed straight from the markdown into functional argument processing. It's a library I wrote called junonia.

The syntax here might be confusing, and I hadn't considered that, but it's the way that arguments receive default values. I will consider if there is perhaps a better way I can concisely do this, but I won't be changing it right now, and if I do then that work would happen over in the junonia repo.

Thanks for your feedback.