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

communication/azure-communication-sms - cspell found spelling errors in source code #22638

Closed
danieljurek opened this issue Jan 21, 2022 · 3 comments
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. Communication

Comments

@danieljurek
Copy link
Member

danieljurek commented Jan 21, 2022

Spell check scanning of package at sdk/communication/azure-communication-sms detected spelling errors in the source code and related files. This directory is opted out of PR spell checking in PR #22199 to keep PRs unblocked.

What to do

  1. Ensure Node.js is installed (https://nodejs.org/en/download/).
  2. Delete the entry in .vscode/cspell.json's ignorePaths field. It will look like: sdk/communication/azure-communication-sms/**. You need to do this to enable checking the files.
  3. From the root of the repo run spell check using ./eng/common/spelling/Invoke-Cspell.ps1 -ScanGlobs "sdk/communication/azure-communication-sms/**"
  4. Fix detections according to http://aka.ms/azsdk/engsys/spellcheck use the "False positives" section to fix false positives
  5. Check in changes (including the change to .vscode/cspell.json where the ignorePaths is updated to remove the entry for this service.). You may need to run git add -f .vscode/cspell.json to force adding the changes to the file in git.

Spell checking output

./sdk/communication/azure-communication-sms/azure/communication/sms/_shared/models.py:28:18 - Unknown word (enviornment)
./sdk/communication/azure-communication-sms/azure/communication/sms/_shared/models.py:32:5 - Unknown word (GCCH)
./sdk/communication/azure-communication-sms/azure/communication/sms/_shared/models.py:32:13 - Unknown word (GCCH)
./sdk/communication/azure-communication-sms/azure/communication/sms/_shared/policy.py:11:46 - Unknown word (IOHTTP)
./sdk/communication/azure-communication-sms/azure/communication/sms/_shared/policy.py:14:33 - Unknown word (IOHTTP)
./sdk/communication/azure-communication-sms/azure/communication/sms/_shared/user_credential_async.py:53:43 - Unknown word (inprogress)
./sdk/communication/azure-communication-sms/azure/communication/sms/_shared/user_credential_async.py:77:26 - Unknown word (inprogress)
./sdk/communication/azure-communication-sms/azure/communication/sms/_shared/user_credential.py:55:37 - Unknown word (inprogress)
./sdk/communication/azure-communication-sms/azure/communication/sms/_shared/user_credential.py:77:20 - Unknown word (inprogress)
./sdk/communication/azure-communication-sms/azure/communication/sms/_shared/utils.py:27:25 - Unknown word (timegm)
./sdk/communication/azure-communication-sms/tests/test_sms_client_async.py:6:8 - Unknown word (aiounittest)
./sdk/communication/azure-communication-sms/tests/test_sms_client_async.py:24:26 - Unknown word (aiounittest)
@danieljurek danieljurek added Client This issue points to a problem in the data-plane of the library. Communication labels Jan 21, 2022
@danieljurek danieljurek changed the title communication/azure-communication-sms - cspell found spelling errors in public API surface communication/azure-communication-sms - cspell found spelling errors in source code Jan 21, 2022
@petrsvihlik
Copy link
Contributor

Note: the files in the _shared folder are owned by the ACS Auth team and will be fixed as part of #22636 for all modalities at once

@petrsvihlik
Copy link
Contributor

Once fixed, we should remove the package from the spellchecker whitelist - #22199

azure-sdk pushed a commit to azure-sdk/azure-sdk-for-python that referenced this issue Mar 7, 2023
Adding version 2023-01-01-preview with User API Key changes for Elastic (Azure#22638)

* Base API Commit

* Changing API version to 2023-02-01-preview

* Adding new getOrganizationApiKey post API

* Adding returnApiKey property in ElasticMonitorResource

* Updating getOrganizationApiKey URI

* Adding SubscriptionIdParameter in getOrganizationApiKey

* Renaming ex to Organizations_GetApiKey

* Updating description for UserApiKeyResponse

* Updating examples

* Updating readme.md

* Updated Depolyment Info, added marketplace info

* prettier check fixed

* model validation fixed

* validation fix

* prettier fix

* Increasing max length limit of companyName and business from 50 to 100

* Increasing companyName and business max length limits to 100 in all versions

* Revert "Increasing companyName and business max length limits to 100 in all versions"

This reverts commit c8977b64daa962bce70d33a325053294a4875610.

* Revert "Increasing max length limit of companyName and business from 50 to 100"

This reverts commit 7bd354775b3a57abf310a351c75763bc1aa121f3.

* Updating summary for getOrganizationApiKey

* Renaming "returnApiKey" to "generateApiKey"

* Adding "x-ms-secret": true for apiKey

* Updating getOrganizationApiKey API to /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/getOrganizationApiKey

* Rearranging APIs

* Adding "consumes" to getOrganizationApiKey

* Changing case of emailId

* Moving the API under paths

* Updating User and Company related properties' max length limit to 64

* Adding Location in response header of LROs

* Updating getOrganizationApiKey path

* Updating getOrganizationApiKey Summary

---------

Co-authored-by: Rhea Hooda <rheahooda@microsoft.com>
Copy link

Hi @danieljurek, we deeply appreciate your input into this project. Regrettably, this issue has remained inactive for over 2 years, leading us to the decision to close it. We've implemented this policy to maintain the relevance of our issue queue and facilitate easier navigation for new contributors. If you still believe this topic requires attention, please feel free to create a new issue, referencing this one. Thank you for your understanding and ongoing support.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Mar 13, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Mar 13, 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. Communication
Projects
None yet
Development

No branches or pull requests

3 participants