docs
docs copied to clipboard
gruntwork-io
Resolve inconsistency in comments for style guide
The Style Guide indicate that a single # should be used, but then has examples with double #, which is confusing
https://github.com/KyleKing/docs/blame/89ba5ba2b1468f55bb77b9b7b1f418eb4af586fe/docs/guides/style/terraform-style-guide.md#L169-L171
Unless the ## -- is the intended guidance, I can also make that change
The changes look correct in deployment: https://6581f385a7bf9a0008663549--pensive-meitner-faaeee.netlify.app/guides/style/terraform-style-guide
Deploy Preview for pensive-meitner-faaeee ready!
| Name | Link |
|---|---|
| Latest commit | 89ba5ba2b1468f55bb77b9b7b1f418eb4af586fe |
| Latest deploy log | https://app.netlify.com/sites/pensive-meitner-faaeee/deploys/6581f385a7bf9a0008663549 |
| Deploy Preview | https://deploy-preview-1361--pensive-meitner-faaeee.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
![netlify[bot] avatar](https://avatars.githubusercontent.com/in/13473?v=4 "Published by a pub.dev verified publisher"){kind=small}
Just following up. This PR makes a minimal change to remove conflicting guidance in the style guide on block comments. Reviewing other code published by Gruntworks supports the change I've submitted here because the examples I found all use the single # --- syntax rather than ## ---.
Examples:
- https://github.com/gruntwork-io/terraform-aws-utilities/blob/a3217852061d0115dbbc2245bdb1abf8f4901574/modules/run-pex-as-data-source/main.tf#L1-L6
- https://github.com/gruntwork-io/terragrunt-infrastructure-modules-example/blob/776c82dc161be3be9303070628056df95ec2b907/asg-elb-service/main.tf#L1-L9
@yhakbar, as the most active contributor in the last month, could you review this PR or know who should review when you have a chance? Thanks!