Skip to content

Commit

Permalink
Add document for 'false' value for CLI flag
Browse files Browse the repository at this point in the history
Boolean flags can only take arguments via '--flag=[true|false]' or for
short names (if available) '-f=[true|false]'. You cannot use
'--flag [true|false]' nor can you use the shorthand '-f [true|false]'.

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
  • Loading branch information
khos2ow committed Apr 5, 2021
1 parent ba608fe commit 6b0cf54
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/user-guide/how-to.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@ weight: 140
toc: true
---

## CLI Flag 'false' value

Boolean flags can only take arguments via `--flag=[true|false]` or for short names
(if available) `-f=[true|false]`. You cannot use `--flag [true|false]` nor can you
use the shorthand `-f [true|false]` as it will result in the following error:

```text
Error: accepts 1 arg(s), received 2
```

## Visibility of Sections

Output generated by `terraform-docs` consists of different [sections] which are
Expand Down

0 comments on commit 6b0cf54

Please sign in to comment.