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

Implement multiline support for tfvars description #158

Merged
merged 3 commits into from
Sep 11, 2024

Conversation

vradicevicds
Copy link
Contributor

@vradicevicds vradicevicds commented Sep 10, 2024

This PR introduces support for generating multiline descriptions in terraform.tfvars.example when variable description is longer than 120 characters.
If string is longer that 120 characters, string is separated into sentences (sliced on ". "). Each sentence is written in a new line, regardless the length.

@vradicevicds vradicevicds force-pushed the cot/tfvars_multiline_description branch from 056b0e7 to 7ec796a Compare September 10, 2024 10:34
@lukabudak
Copy link
Contributor

Why did you pick 350 characters for cutoff limit?

@lukabudak
Copy link
Contributor

Why did you pick 350 characters for cutoff limit?

Usually there are arguments for 80, 100 and 120 characters.
Additional line length limits

@vradicevicds
Copy link
Contributor Author

vradicevicds commented Sep 11, 2024

Why did you pick 350 characters for cutoff limit?

Usually there are arguments for 80, 100 and 120 characters. Additional line length limits

Good point. 350 is selected because there are existing descriptions with up to 350 characters, which are tolerated.
We can agree to change this to 120.

Copy link
Contributor

@lukabudak lukabudak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@vradicevicds vradicevicds merged commit dd2648a into main Sep 11, 2024
@vradicevicds vradicevicds deleted the cot/tfvars_multiline_description branch September 11, 2024 06:40
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

Successfully merging this pull request may close these issues.

2 participants