-
Notifications
You must be signed in to change notification settings - Fork 62
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
Use Vale spellchecker on YAML files. #680
Merged
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
Changes AnalysisCommit SHA: 442dbed API ChangesSummary
ReportThe full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/11900805675/artifacts/2203881355 API Coverage
|
Spec Test Coverage Analysis
|
Signed-off-by: dblock <[email protected]>
Signed-off-by: dblock <[email protected]>
dblock
force-pushed
the
vale-spellchecker
branch
from
November 18, 2024 14:41
8a476ce
to
5b9f7f2
Compare
Signed-off-by: dblock <[email protected]>
dblock
force-pushed
the
vale-spellchecker
branch
from
November 18, 2024 20:15
de43481
to
081efc8
Compare
dblock
requested review from
harshavamsi,
sachetalva,
nhtruong,
Xtansia,
VachaShah,
Tokesh and
aabeshov
as code owners
November 18, 2024 20:17
dblock
force-pushed
the
vale-spellchecker
branch
2 times, most recently
from
November 18, 2024 20:27
0976c52
to
6c704ad
Compare
Xtansia
previously approved these changes
Nov 18, 2024
dblock
force-pushed
the
vale-spellchecker
branch
from
November 18, 2024 20:40
6c704ad
to
9c3e54a
Compare
Signed-off-by: dblock <[email protected]>
dblock
force-pushed
the
vale-spellchecker
branch
from
November 18, 2024 20:46
9c3e54a
to
442dbed
Compare
Xtansia
approved these changes
Nov 18, 2024
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.
Description
Do not use the eslint spellchecker on YAML files, instead use Vale. It makes the cspell dictionary really small and therefore easier to maintain and improves descriptions by checking their spelling with the rules of our documentation project. This required preprocessing backtick-quoted
variables
away as **** so that Vale doesn't trip on those as it doesn't know what format we're checking.To see all violations locally you can do
There are at least 180 left after this PR, so I didn't go fixing them all. GitHub PRs don't show violations as errors unless you're modifying that file/line.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.