-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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
network - cspell found spelling errors in public API surface #23184
Comments
same issue with #23188 |
Since we are still working on the new track 2 onboarding for this RP, we will do this after the release is done for network |
I checked some of those errors, and I think we'd better just choose to skip spell check for generated codes. Those nouns are not correctly spelled in swagger definition. For example, |
However, we could try to reduce the scope of ignored folders, so that we can still catch some spelling problems elsewhere (like tests, samples, and docs). |
The cspell errors in `Network` SDK are due to the problematic naming in `Network` swagger definitions. We can hardly fix those, so put them into the ignore list. resolve Azure#23184
@danieljurek I've created a PR #24073 to fix the spelling errors |
The cspell errors in `Network` SDK are due to the problematic naming in `Network` swagger definitions. We can hardly fix those, so put them into the ignore list. resolve #23184
Investigation for this PR: #23150 found spelling errors. When the linked PR merges this service will be opted out of public API surface spell checking to keep other PRs unblocked. This issue describes how to opt back in.
If the above linked PR has not merged this service is still opted out and not blocked by the detection of spelling errors in the public API surface.
What to do
Correct errors
To correct false positives or learn about spell checking see: https://aka.ms/azsdk/engsys/spellcheck
Spell Check Output
To check the public API surface locally, in the root of the repo run:
You may also need to set
-SDKType
if the appropriate value ofSDKType
is notall
for the service.Opt back in
NEW INSTRUCTIONS: In the
.vscode/cspell.json
file remove the line for your service (of the form"sdk/<service>/*/api/*.cs"
) from theignorePaths
section and check in the change.OLD INSTRUCTIONS:
In theci.yml
file for this service, remove the line:SpellCheckPublicApiSurface: false
The text was updated successfully, but these errors were encountered: