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

purview - cspell found spelling errors in public API surface #23185

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

purview - cspell found spelling errors in public API surface #23185

danieljurek opened this issue Aug 6, 2021 · 0 comments
Labels
Client This issue points to a problem in the data-plane of the library. Purview Service Attention Workflow: This issue is responsible by Azure service team.

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/2 .\sdk\purview\Azure.Analytics.Purview.Catalog\api\Azure.Analytics.Purview.Catalog.netstandard2.0.cs 1017.59ms
2/2 .\sdk\purview\Azure.Analytics.Purview.Scanning\api\Azure.Analytics.Purview.Scanning.netstandard2.0.cs 111.73ms X
D:\code\azure-sdk-for-net\sdk\purview\Azure.Analytics.Purview.Scanning\api\Azure.Analytics.Purview.Scanning.netstandard2.0.cs:71:57 - Unknown word (Ruelset)
D:\code\azure-sdk-for-net\sdk\purview\Azure.Analytics.Purview.Scanning\api\Azure.Analytics.Purview.Scanning.netstandard2.0.cs:72:86 - Unknown word (Ruelset)
D:\code\azure-sdk-for-net\sdk\purview\Azure.Analytics.Purview.Scanning\api\Azure.Analytics.Purview.Scanning.netstandard2.0.cs:87:54 - Unknown word (Rulestes)
D:\code\azure-sdk-for-net\sdk\purview\Azure.Analytics.Purview.Scanning\api\Azure.Analytics.Purview.Scanning.netstandard2.0.cs:88:83 - Unknown word (Rulestes)
D:\code\azure-sdk-for-net\sdk\purview\Azure.Analytics.Purview.Scanning\api\Azure.Analytics.Purview.Scanning.netstandard2.0.cs:101:42 - Unknown word (Unparented)
D:\code\azure-sdk-for-net\sdk\purview\Azure.Analytics.Purview.Scanning\api\Azure.Analytics.Purview.Scanning.netstandard2.0.cs:102:71 - Unknown word (Unparented)
CSpell: Files checked: 2, Issues found: 6 in 1 files

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

eng/scripts/Export-API.ps1 -ServiceDirectory purview -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 Client This issue points to a problem in the data-plane of the library. Purview 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
azure-sdk pushed a commit to azure-sdk/azure-sdk-for-net that referenced this issue Mar 22, 2023
azure-sdk pushed a commit to azure-sdk/azure-sdk-for-net that referenced this issue Mar 22, 2023
@pallavit pallavit added the Service Attention Workflow: This issue is responsible by Azure service team. label Dec 15, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Mar 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Client This issue points to a problem in the data-plane of the library. Purview Service Attention Workflow: This issue is responsible by Azure service team.
Projects
None yet
Development

No branches or pull requests

4 participants