terraform-docs should not fail if complex types contain 'description' keyword #174
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix description key inside type
This PR fixes a when a key named
description
is inside thetype
block of a variable section:Integration tests
Test for this can be found here: https://github.com/cytopia/docker-terraform-docs/blob/master/tests/0.12/main.tf#L60
Reliability
I tried to fix this to the best of my knowledge and currently available test cases. Please do test this before merging on existing files.