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

network - cspell found spelling errors in public API surface #23184

Closed
danieljurek opened this issue Aug 6, 2021 · 5 comments · Fixed by #24073
Closed

network - cspell found spelling errors in public API surface #23184

danieljurek opened this issue Aug 6, 2021 · 5 comments · Fixed by #24073
Assignees
Labels
Mgmt This issue is related to a management-plane library. Network

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\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs 1464.67ms X
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:387:123 - Unknown word (Ddos)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:393:62 - Unknown word (Ddos)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:397:110 - Unknown word (Ddos)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:398:110 - Unknown word (Ddos)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:416:131 - Unknown word (ddos)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:417:165 - Unknown word (ddos)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:418:149 - Unknown word (ddos)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:419:183 - Unknown word (ddos)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:1639:83 - Unknown word (Wans)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:2860:234 - Unknown word (Unprepare)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:2861:268 - Unknown word (Unprepare)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:3563:33 - Unknown word (Wans)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:3565:26 - Unknown word (Wans)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:3576:33 - Unknown word (Wans)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:4412:86 - Unknown word (WAFV)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:4441:93 - Unknown word (TLSDHEDSS)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:4442:93 - Unknown word (TLSDHEDSS)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:4443:93 - Unknown word (TLSDHEDSS)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:4444:93 - Unknown word (TLSDHEDSS)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:4446:93 - Unknown word (TLSDHERSA)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:4447:93 - Unknown word (TLSDHERSA)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:4448:93 - Unknown word (TLSDHERSA)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:4449:93 - Unknown word (TLSDHERSA)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:4560:83 - Unknown word (WAFV)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:4623:63 - Unknown word (Fqdns)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:4657:81 - Unknown word (Eapmscha)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:4658:81 - Unknown word (Eaptls)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:4785:63 - Unknown word (Fqdns)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:4857:89 - Unknown word (Dnat)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:4858:89 - Unknown word (Snat)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:4898:68 - Unknown word (Fqdns)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:4976:81 - Unknown word (Azfw)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:4977:81 - Unknown word (Azfw)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:5717:32 - Unknown word (Mbps)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:6088:32 - Unknown word (Mbps)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:6181:32 - Unknown word (Mbps)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:6425:28 - Unknown word (Mbps)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:6514:92 - Unknown word (Dnat)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:6631:57 - Unknown word (Fqdns)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:6974:23 - Unknown word (Ipconfiguration)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:7288:86 - Unknown word (Owasp)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:7311:30 - Unknown word (Conditon)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:7553:141 - Unknown word (Nics)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:7691:26 - Unknown word (Owasp)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:7693:16 - Unknown word (Owasp)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:7693:76 - Unknown word (Owasp)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:7940:69 - Unknown word (Pfsmm)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:8632:93 - Unknown word (Deprovisioning)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:8851:26 - Unknown word (Unprepare)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:8853:16 - Unknown word (Unprepare)
D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:9479:78 - Unknown word (Sstp)
CSpell: Files checked: 1, Issues found: 51 in 1 files

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

eng/scripts/Export-API.ps1 -ServiceDirectory network -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. Network 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

same issue with #23188

@yungezz yungezz assigned ArcturusZhang and unassigned allenjzhang Aug 23, 2021
@ArcturusZhang
Copy link
Member

ArcturusZhang commented Aug 30, 2021

Since we are still working on the new track 2 onboarding for this RP, we will do this after the release is done for network
Add @archerzz for awareness

@archerzz
Copy link
Member

archerzz commented Sep 7, 2021

I checked some of those errors, and I think we'd better just choose to skip spell check for generated codes. Those nouns are not correctly spelled in swagger definition. For example, D:\code\azure-sdk-for-net\sdk\network\Azure.ResourceManager.Network\api\Azure.ResourceManager.Network.netstandard2.0.cs:6974:23 - Unknown word (Ipconfiguration) is because of the swagger definition here.

@archerzz
Copy link
Member

archerzz commented Sep 7, 2021

However, we could try to reduce the scope of ignored folders, so that we can still catch some spelling problems elsewhere (like tests, samples, and docs).

archerzz added a commit to archerzz/azure-sdk-for-net that referenced this issue Sep 17, 2021
The cspell errors in `Network` SDK are due to the problematic naming in `Network` swagger definitions. We can hardly fix those, so put them into the ignore list.

resolve Azure#23184
@archerzz archerzz assigned archerzz and unassigned ArcturusZhang Sep 17, 2021
@archerzz
Copy link
Member

@danieljurek I've created a PR #24073 to fix the spelling errors

archerzz added a commit that referenced this issue Sep 22, 2021
The cspell errors in `Network` SDK are due to the problematic naming in `Network` swagger definitions. We can hardly fix those, so put them into the ignore list.

resolve #23184
@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
Mgmt This issue is related to a management-plane library. Network
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants