chore: add vale rule to enforce colon usage #2441
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lennessyy
added
backport-version-4-0
✅ Deploy Preview for docs-spectrocloud ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -337,7 +337,7 @@ stages: | |||
|
|
|||
| #### Invoke Custom Script | |||
|
|
|||
| An example of applying logic after the device has booted by using the `boot.after` stage. <br /> | |||
| An example of applying logic after the device has booted by using the `boot.after` stage: | |||
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud.colon] Use colons only to introduce lists, unless in code blocks or inline code.
There was a problem hiding this comment.
Yay - this is working as intended
karl-cardenas-coding
approved these changes
Mar 21, 2024
💔 All backports failed
Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation and see the Github Action logs for details |
|
🎉 This PR is included in version 4.2.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 4.2.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Describe the Change
This PR ensures that colons are only used to introduce a list. It specifically looks for a colon, followed by two new line characters, and then any character that is not a dash or a new line. I think this is also the most frequent mistake for us which is to introduce a command with a colon.
It does not try to catch instances of inline colon usage such as
There are three kinds of apples: fuji, honey crisp, and cosmic crisp, which I think is permissible and avoids flagging all the false positives in code blocks.It is possible that this rule could lead to some false positives in code snippets, but there should be only very few of these, and i think we can usually remove the extra new line character if they occur.
Changed Pages
N/A
Jira Tickets
🎫 DOC-1114
Backports
Can this PR be backported?