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

Resolve inconsistency in comments for style guide #1361

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

KyleKing
Copy link

@KyleKing KyleKing commented Dec 19, 2023

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

Copy link

netlify bot commented Dec 19, 2023

Deploy Preview for pensive-meitner-faaeee ready!

Name Link
🔨 Latest commit 89ba5ba
🔍 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...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@KyleKing
Copy link
Author

Just following up, does someone have time to take a look at this PR?

@KyleKing
Copy link
Author

KyleKing commented Apr 3, 2024

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:

@KyleKing
Copy link
Author

@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!

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.

None yet

1 participant