Skip to content

Commit

Permalink
Clarify deprecated settings in the docs (#499)
Browse files Browse the repository at this point in the history
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
  • Loading branch information
khos2ow committed May 6, 2021
1 parent 90ccb84 commit 7327de1
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions docs/user-guide/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,8 @@ settings:
- `sections.hide-all` and `sections.hide`
- `sections.show-all` and `sections.show`

**Note:** As of `v0.13.0`, `sections.hide-all` and `settings.show-all` are deprecated
and removed in favor of explicit use of `settings.hide` and `settings.show`.
**Note:** As of `v0.13.0`, `sections.hide-all` and `sections.show-all` are deprecated
and removed in favor of explicit use of `sections.hide` and `sections.show`.

## Version

Expand Down Expand Up @@ -189,6 +189,9 @@ The following options are supported and can be used for `sections.show` and
- `requirements`
- `resources` (since `v0.11.0`)

**Note:** As of `v0.13.0`, `sections.hide-all` and `sections.show-all` are deprecated
and removed in favor of explicit use of `sections.hide` and `sections.show`.

## Output

Since `v0.12.0`
Expand Down Expand Up @@ -301,3 +304,20 @@ The following sort types are supported:
- `name` (default): name of items
- `required`: by name of inputs AND show required ones first
- `type`: type of inputs

**Note:** As of `v0.13.0`, `sort.by` is converted from `list` to `string`.

```yaml
sort:
enabled: true
by: required # this now only accepts string
```

The following error is an indicator that `.terraform-docs.yml` still uses
list for `sort.by`.

```text
Error: unable to decode config, 1 error(s) decoding:
* 'sort.by' expected type 'string', got unconvertible type '[]interface {}'
```

0 comments on commit 7327de1

Please sign in to comment.