Skip to content
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

sqlmanagement - cspell found spelling errors in public API surface #23188

Closed
danieljurek opened this issue Aug 6, 2021 · 1 comment · Fixed by #25204
Closed

sqlmanagement - cspell found spelling errors in public API surface #23188

danieljurek opened this issue Aug 6, 2021 · 1 comment · Fixed by #25204
Assignees
Labels
Mgmt This issue is related to a management-plane library. SQL

Comments

@danieljurek
Copy link
Member

danieljurek commented Aug 6, 2021

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

  1. Correct spelling errors or check in fixes for the false positives
  2. Opt back into Public API surafe spell checking

Correct errors

To correct false positives or learn about spell checking see: https://aka.ms/azsdk/engsys/spellcheck

Spell Check Output

1/1 .\sdk\sqlmanagement\Azure.ResourceManager.Sql\api\Azure.ResourceManager.Sql.netstandard2.0.cs 1325.21ms X
D:\code\azure-sdk-for-net\sdk\sqlmanagement\Azure.ResourceManager.Sql\api\Azure.ResourceManager.Sql.netstandard2.0.cs:1639:165 - Unknown word (Droppeded)
D:\code\azure-sdk-for-net\sdk\sqlmanagement\Azure.ResourceManager.Sql\api\Azure.ResourceManager.Sql.netstandard2.0.cs:1640:199 - Unknown word (Droppeded)
D:\code\azure-sdk-for-net\sdk\sqlmanagement\Azure.ResourceManager.Sql\api\Azure.ResourceManager.Sql.netstandard2.0.cs:2712:96 - Unknown word (CIAS)
D:\code\azure-sdk-for-net\sdk\sqlmanagement\Azure.ResourceManager.Sql\api\Azure.ResourceManager.Sql.netstandard2.0.cs:3652:102 - Unknown word (Vcores)
D:\code\azure-sdk-for-net\sdk\sqlmanagement\Azure.ResourceManager.Sql\api\Azure.ResourceManager.Sql.netstandard2.0.cs:3652:129 - Unknown word (Vcores)
D:\code\azure-sdk-for-net\sdk\sqlmanagement\Azure.ResourceManager.Sql\api\Azure.ResourceManager.Sql.netstandard2.0.cs:3677:38 - Unknown word (Vcores)
D:\code\azure-sdk-for-net\sdk\sqlmanagement\Azure.ResourceManager.Sql\api\Azure.ResourceManager.Sql.netstandard2.0.cs:3679:30 - Unknown word (Vcores)
D:\code\azure-sdk-for-net\sdk\sqlmanagement\Azure.ResourceManager.Sql\api\Azure.ResourceManager.Sql.netstandard2.0.cs:4079:65 - Unknown word (Unrestorable)
CSpell: Files checked: 1, Issues found: 8 in 1 files

To check the public API surface locally, in the root of the repo run:

eng/scripts/Export-API.ps1 -ServiceDirectory sqlmanagement -SpellCheckPublicApiSurface

You may also need to set -SDKType if the appropriate value of SDKType is not all 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 the ignorePaths section and check in the change.

OLD INSTRUCTIONS: In the ci.yml file for this service, remove the line: SpellCheckPublicApiSurface: false

@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Aug 6, 2021
@jsquire jsquire added Mgmt This issue is related to a management-plane library. SQL labels Aug 7, 2021
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Aug 7, 2021
@yungezz
Copy link
Member

yungezz commented Aug 23, 2021

Azure.ResourceManager.Sql pacakge or Azure.ResourceManager.* is old Track2 pacakges. They'll not be updated, and will be deprecated. While we can see if the issue is in new Track2 SDK. add @ArcturusZhang to help confirm on this.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Mgmt This issue is related to a management-plane library. SQL
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants