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

containerregistry - cspell found spelling errors in public API surface #23175

Closed
danieljurek opened this issue Aug 6, 2021 · 2 comments
Closed
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. Container Registry

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\containerregistry\Azure.Containers.ContainerRegistry\api\Azure.Containers.ContainerRegistry.netstandard2.0.cs 1080.63ms X
D:\code\azure-sdk-for-net\sdk\containerregistry\Azure.Containers.ContainerRegistry\api\Azure.Containers.ContainerRegistry.netstandard2.0.cs:74:82 - Unknown word (Illumos)
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 containerregistry -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
@danieljurek danieljurek added Client This issue points to a problem in the data-plane of the library. Container Registry labels Aug 6, 2021
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Aug 6, 2021
@annelo-msft annelo-msft removed their assignment Sep 15, 2021
@AlexGhiondea
Copy link
Contributor

@danieljurek is there a way to add this work to an allow list? The name that is flagged represents a known unix distro.

@Mohit-Chakraborty
Copy link
Contributor

We can follow one of the documented steps to handle this false positive.
I'll assign this issue to myself for the cleanup.

@Mohit-Chakraborty Mohit-Chakraborty self-assigned this Oct 5, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Mar 27, 2023
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. Container Registry
Projects
None yet
Development

No branches or pull requests

5 participants