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

monitor - cspell found spelling errors in public API surface #23183

Closed
danieljurek opened this issue Aug 6, 2021 · 2 comments · Fixed by #37077
Closed

monitor - cspell found spelling errors in public API surface #23183

danieljurek opened this issue Aug 6, 2021 · 2 comments · Fixed by #37077
Labels
Client This issue points to a problem in the data-plane of the library. Monitor Monitor, Monitor Ingestion, Monitor Query 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\monitor\Azure.Monitor.OpenTelemetry.Exporter\api\Azure.Monitor.OpenTelemetry.Exporter.netstandard2.0.cs 926.95ms
2/2 .\sdk\monitor\Azure.Monitor.Query\api\Azure.Monitor.Query.netstandard2.0.cs 102.17ms X
D:\code\azure-sdk-for-net\sdk\monitor\Azure.Monitor.Query\api\Azure.Monitor.Query.netstandard2.0.cs:267:61 - Unknown word (Milli)
CSpell: Files checked: 2, 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 monitor -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. Monitor - Exporter Monitor OpenTelemetry Exporter Service Attention Workflow: This issue is responsible by Azure service team. 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
@scottaddie scottaddie added the Monitor Monitor, Monitor Ingestion, Monitor Query label Jun 15, 2022
@ghost
Copy link

ghost commented Jun 15, 2022

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @sameergMS, @dadunl.

Issue Details

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\monitor\Azure.Monitor.OpenTelemetry.Exporter\api\Azure.Monitor.OpenTelemetry.Exporter.netstandard2.0.cs 926.95ms
2/2 .\sdk\monitor\Azure.Monitor.Query\api\Azure.Monitor.Query.netstandard2.0.cs 102.17ms X
D:\code\azure-sdk-for-net\sdk\monitor\Azure.Monitor.Query\api\Azure.Monitor.Query.netstandard2.0.cs:267:61 - Unknown word (Milli)
CSpell: Files checked: 2, 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 monitor -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

Author: danieljurek
Assignees: -
Labels:

Monitor, Service Attention, Client, Monitor - Exporter

Milestone: -

@reyang
Copy link
Member

reyang commented Feb 21, 2023

@jsquire this doesn't seem to be related to "Monitor - Exporter" (FYI @rajkumar-rangaraj)

D:\code\azure-sdk-for-net\sdk\monitor\Azure.Monitor.Query\api\Azure.Monitor.Query.netstandard2.0.cs:267:61 - Unknown word (Milli)
CSpell: Files checked: 2, Issues found: 1 in 1 files

@reyang reyang removed the Monitor - Exporter Monitor OpenTelemetry Exporter label Feb 21, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Sep 14, 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. Monitor Monitor, Monitor Ingestion, Monitor Query Service Attention Workflow: This issue is responsible by Azure service team.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants