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

feat: Improving locals documentation #3148

Merged
merged 2 commits into from
May 21, 2024

Conversation

yhakbar
Copy link
Collaborator

@yhakbar yhakbar commented May 20, 2024

Description

Fixes #3129.

TODOs

Read the Gruntwork contribution guidelines.

  • Update the docs.
  • Run the relevant tests successfully, including pre-commit checks.
  • Ensure any 3rd party code adheres with our license policy or delete this line if its not applicable.
  • Include release notes. If this PR is backward incompatible, include a migration guide.

Release Notes (draft)

Updated locals.md docs.

@yhakbar yhakbar requested a review from denis256 as a code owner May 20, 2024 21:40
@yhakbar yhakbar force-pushed the feat/improving-locals-documentation branch 2 times, most recently from c5f973f to df49554 Compare May 20, 2024 21:41
@yhakbar yhakbar force-pushed the feat/improving-locals-documentation branch from df49554 to bbf85c4 Compare May 20, 2024 21:41
denis256
denis256 previously approved these changes May 21, 2024
Comment on lines 111 to 112
```hcl
locals {
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider adding the name of the file in which this is running.

Copy link

sonarcloud bot commented May 21, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@yhakbar yhakbar merged commit f20b9ed into master May 21, 2024
4 checks passed
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.

Documentation Show the contents of the 'common_vars.yaml' file and format reasoning
3 participants