-
Notifications
You must be signed in to change notification settings - Fork 149
Update cspell.json #2725
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
Update cspell.json #2725
Conversation
danieljurek
commented
Aug 10, 2021
- include documentation
- add eng/common to exclusion list
- add language-specific dictionary to 'dictionaries' entry to avoid false positives in language-specific keywords in documentation or other files
|
This pull request is protected by Check Enforcer. What is Check Enforcer?Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass. Why am I getting this message?You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged. What should I do now?If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows: What if I am onboarding a new service?Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment: |
|
Thank you @danieljurek! Does this mean that we can update this dictionary to allow Unicode words that are not in the dictionary (https://github.com/Azure/azure-sdk-for-cpp/pull/2551/files#diff-cc1b46c667702f97b0f4104c7637ccca9da686d2df0cd9e47a39f12ced659897L17)? Or is it to fix some different part of the spell check/address different part of the system? (because last time, the spell check did not fail the PR with "Jørgen", and only during the release we did find out) |
|
@antkmsft -- the unicode error we encountered on release was not the result of a spell check failing so this update doesn't address that. It was a failure that occurred when we attempted to post to the GitHub API some content for a release. This PR is some cleanup work being done in each repo ahead of this PR which will give teams the ability to opt into failing CI when spelling errors are detected in PRs -- Azure/azure-sdk-tools#1887 |
…n list, add language-specific dictionary to 'dictionaries' entry to avoid false positives in language-specific keywords in documentation or other files
82a44c6 to
42f76ae
Compare
| default: 'sdk/*/*/*cov_xml.xml' | ||
| - name: FailOnSpellingErrors | ||
| type: boolean | ||
| default: false |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a reason to add this until we ready to set it to true in at lease one place?
Also we seem to be adding in some double negatives (i.e. not(Fail..)) I wonder if we if we should call this ContinueOnSpellingErrors just to align with what we are passing it to.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I had other names which were worse... ContinueOnSpellingErrors is much better than anything I had this morning.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, the reason to add this is to give people the ability to opt into it when ready.
|
@danieljurek Is this waiting on anything? |
|
This should be closed in favor of #2794 |