docs(vocab): Clarify multiple vocabulary usage#37
Closed
rpatterson wants to merge 1 commit intovale-cli:masterfrom
Closed
docs(vocab): Clarify multiple vocabulary usage#37rpatterson wants to merge 1 commit intovale-cli:masterfrom
rpatterson wants to merge 1 commit intovale-cli:masterfrom
Conversation
This was a big point of confusion for me getting started with Vale. I ended up doing some trial and error to figure out the behavior of the `Vocab` setting. Hopefully this, or some other clarifying language might save others the same confusion.
✅ Deploy Preview for eclectic-semifreddo-be083c ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
rpatterson
added a commit
to rpatterson/project-structure
that referenced
this pull request
May 16, 2023
Because [Vale treats a script's shebang as a comment](vale-cli/vale#631 (comment)), our only options for workarounds are either disabling the rule altogether or adding exceptions for the words in shebangs. The latter is preferable because allows us to still use the rule for the rest of that rule's word list. [There's only one `Vocab` per configuration](vale-cli/vale.sh#37 (comment)), however, so to limit the exception to only code comments and to keep the word in the rule's word list for markup, use separate Vale configurations for code and markup.
Member
|
Closing this because my intent is to address the underlying issue: vocabularies should be supported format-specific sections. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
A big point of confusion for me getting started with Vale was how to use different vocabularies for code comments than for markup and text. I ended up doing some trial and error to figure out the behavior of the
Vocabsetting. Hopefully this, or some other clarifying language might save others the same confusion.