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-identity - cspell found spelling errors in source code #22636

Closed
danieljurek opened this issue Jan 21, 2022 · 3 comments · Fixed by #23085
Closed
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-identity 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-identity/**. 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-identity/**"
  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-identity/azure/communication/identity/_shared/models.py:28:18 - Unknown word (enviornment)
./sdk/communication/azure-communication-identity/azure/communication/identity/_shared/models.py:32:5 - Unknown word (GCCH)
./sdk/communication/azure-communication-identity/azure/communication/identity/_shared/models.py:32:13 - Unknown word (GCCH)
./sdk/communication/azure-communication-identity/azure/communication/identity/_shared/policy.py:11:46 - Unknown word (IOHTTP)
./sdk/communication/azure-communication-identity/azure/communication/identity/_shared/policy.py:14:33 - Unknown word (IOHTTP)
./sdk/communication/azure-communication-identity/azure/communication/identity/_shared/user_credential_async.py:53:43 - Unknown word (inprogress)
./sdk/communication/azure-communication-identity/azure/communication/identity/_shared/user_credential_async.py:77:26 - Unknown word (inprogress)
./sdk/communication/azure-communication-identity/azure/communication/identity/_shared/user_credential.py:55:37 - Unknown word (inprogress)
./sdk/communication/azure-communication-identity/azure/communication/identity/_shared/user_credential.py:77:20 - Unknown word (inprogress)
./sdk/communication/azure-communication-identity/azure/communication/identity/_shared/utils.py:27:25 - Unknown word (timegm)
./sdk/communication/azure-communication-identity/tests/user_credential_tests.py:14:52 - Unknown word (XVCJ)
./sdk/communication/azure-communication-identity/tests/user_credential_tests.py:15:26 - Unknown word (Njgw)
./sdk/communication/azure-communication-identity/tests/user_credential_tests.py:15:40 - Unknown word (FNNHHJT)
./sdk/communication/azure-communication-identity/tests/user_credential_tests.py:17:53 - Unknown word (XVCJ)
./sdk/communication/azure-communication-identity/tests/user_credential_tests.py:18:49 - Unknown word (Zwiz)
./sdk/communication/azure-communication-identity/tests/user_credential_tests.py:18:65 - Unknown word (nypg)
./sdk/communication/azure-communication-identity/tests/user_credential_tests.py:52:72 - Unknown word (asnecessary)
@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-identity - cspell found spelling errors in public API surface communication/azure-communication-identity - cspell found spelling errors in source code Jan 21, 2022
@petrsvihlik
Copy link
Contributor

@petrsvihlik
Copy link
Contributor

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

@petrsvihlik
Copy link
Contributor

And also close #22635 - network traversal does not contain any other changes than in the _shared folder

AikoBB pushed a commit to AikoBB/azure-sdk-for-python that referenced this issue Feb 16, 2022
petrsvihlik pushed a commit that referenced this issue Feb 17, 2022
Co-authored-by: Aigerim Beishenbekova <aigerimb@Aigerims-MacBook-Pro-2.local>
iscai-msft added a commit to iscai-msft/azure-sdk-for-python that referenced this issue Mar 4, 2022
…into new_metrics_advisor

* 'main' of https://github.com/Azure/azure-sdk-for-python: (601 commits)
  pin markupsafe (Azure#23132)
  [Communication] - phone-numbers - Implement a phone number pool for update capabilities live tests (Azure#23116)
  Add timeout on Invoke-request call (Azure#23120)
  Sync eng/common directory with azure-sdk-tools for PR 2775 (Azure#23115)
  Update aggregate-report to use common credscan yml and update baseline file (Azure#23090)
  Update CHANGELOG.md (Azure#23119)
  [Issue helper] Update owner list (Azure#23079)
  [KV] Update changelogs for stable releases (Azure#23053)
  code and test (Azure#23047)
  [recoveryservicesbackup] fix multiple pages paging (Azure#23089)
  rerecord failing tests for fr (Azure#23107)
  [Test Proxy] Remove unnecessary git SHA fetch (Azure#23113)
  [Storage] Fix some mypy typing errors and typing imports (Azure#23098)
  Add logic to generate docs.ms ToC (Azure#23086)
  Fix broken link in tests.md (Azure#23110)
  Enable apistub gen step (Azure#23088)
  pin version of storage blob used for testing (Azure#23109)
  ensure that py36 can start the process properly (Azure#23108)
  fix cspell issues for azure-communication identity (Azure#22636) (Azure#23085)
  code and test (Azure#23077)
  ...
rakshith91 pushed a commit to rakshith91/azure-sdk-for-python that referenced this issue Apr 10, 2022
…re#23085)

Co-authored-by: Aigerim Beishenbekova <aigerimb@Aigerims-MacBook-Pro-2.local>
@github-actions github-actions bot locked and limited conversation to collaborators Apr 11, 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. Communication
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants