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

cosmosdb - cspell found spelling errors in public API surface #23176

Closed
danieljurek opened this issue Aug 6, 2021 · 3 comments
Closed

cosmosdb - cspell found spelling errors in public API surface #23176

danieljurek opened this issue Aug 6, 2021 · 3 comments
Assignees
Labels
Cosmos Mgmt This issue is related to a management-plane library.
Milestone

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\cosmosdb\Azure.ResourceManager.CosmosDB\api\Azure.ResourceManager.CosmosDB.netstandard2.0.cs 1604.57ms X
D:\code\azure-sdk-for-net\sdk\cosmosdb\Azure.ResourceManager.CosmosDB\api\Azure.ResourceManager.CosmosDB.netstandard2.0.cs:2178:23 - Unknown word (Colls)
CSpell: Files checked: 1, Issues found: 1 in 1 files

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

eng/scripts/Export-API.ps1 -ServiceDirectory cosmosdb -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 Cosmos Mgmt This issue is related to a management-plane library. 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 yungezz assigned ArcturusZhang and unassigned allenjzhang Aug 23, 2021
@yungezz
Copy link
Member

yungezz commented Aug 23, 2021

same issue with #23188

@archerzz
Copy link
Member

cosmos mgmt track2 SDK is still ongoing. I'll update the cspell rules after the SDK is ready for preview. Thanks.

@jsquire jsquire modified the milestones: [2022] January, Backlog Jan 18, 2022
@ArcturusZhang ArcturusZhang removed their assignment Jan 26, 2022
@ArthurMa1978
Copy link
Member

This has been fixed by #25204

@github-actions github-actions bot locked and limited conversation to collaborators Apr 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Cosmos Mgmt This issue is related to a management-plane library.
Projects
None yet
Development

No branches or pull requests

7 participants