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

remoterendering/azure-mixedreality-remoterendering - cspell found spelling errors in source code #22669

Closed
danieljurek opened this issue Jan 21, 2022 · 3 comments · Fixed by #25927
Labels
Client This issue points to a problem in the data-plane of the library. Mixed Reality needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team Service Attention Workflow: This issue is responsible by Azure service team.

Comments

@danieljurek
Copy link
Member

danieljurek commented Jan 21, 2022

Spell check scanning of package at sdk/remoterendering/azure-mixedreality-remoterendering 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/remoterendering/azure-mixedreality-remoterendering/**. 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/remoterendering/azure-mixedreality-remoterendering/**"
  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/remoterendering/azure-mixedreality-remoterendering/azure/mixedreality/remoterendering/_polling.py:17:19 - Unknown word (unsubscriptable)
./sdk/remoterendering/azure-mixedreality-remoterendering/azure/mixedreality/remoterendering/_shared/mixedreality_account_key_credential.py:38:41 - Unknown word (mktime)
./sdk/remoterendering/azure-mixedreality-remoterendering/azure/mixedreality/remoterendering/aio/_polling_async.py:25:19 - Unknown word (unsubscriptable)
./sdk/remoterendering/azure-mixedreality-remoterendering/azure/mixedreality/remoterendering/aio/_remote_rendering_client_async.py:38:19 - Unknown word (unsubscriptable)
./sdk/remoterendering/azure-mixedreality-remoterendering/README.md:72:16 - Unknown word (ACCOUNTD)
./sdk/remoterendering/azure-mixedreality-remoterendering/README.md:95:16 - Unknown word (ACCOUNTD)
./sdk/remoterendering/azure-mixedreality-remoterendering/README.md:127:16 - Unknown word (ACCOUNTD)
./sdk/remoterendering/azure-mixedreality-remoterendering/samples/remote_rendering_client_sample_async.py:173:83 - Unknown word (Hololens)
./sdk/remoterendering/azure-mixedreality-remoterendering/samples/remote_rendering_client_sample.py:173:83 - Unknown word (Hololens)
./sdk/remoterendering/azure-mixedreality-remoterendering/tests/test_client_async.py:179:50 - Unknown word (thisisnotthekey)
./sdk/remoterendering/azure-mixedreality-remoterendering/tests/test_client.py:178:50 - Unknown word (thisisnotthekey)
@danieljurek danieljurek added the Client This issue points to a problem in the data-plane of the library. label Jan 21, 2022
@danieljurek danieljurek changed the title remoterendering/azure-mixedreality-remoterendering - cspell found spelling errors in public API surface remoterendering/azure-mixedreality-remoterendering - cspell found spelling errors in source code Jan 21, 2022
@danieljurek danieljurek added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Jan 21, 2022
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Jan 24, 2022
@SatishBoddu-MSFT SatishBoddu-MSFT self-assigned this Feb 10, 2022
@SatishBoddu-MSFT SatishBoddu-MSFT added the needs-author-feedback Workflow: More information is needed from author to address the issue. label Feb 10, 2022
@SatishBoddu-MSFT
Copy link

Hello @danieljurek Could you please let us know further action on this Github issue? Should we close or keep it open//

@danieljurek
Copy link
Member Author

This issue tracks resolving spelling error detections in the Azure SDK code. If the issues are resolved according to the instructions then this can be closed. If the issues are not resolved then we should keep this open to track that the work is not completed.

@ghost ghost added needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team and removed needs-author-feedback Workflow: More information is needed from author to address the issue. labels Feb 10, 2022
@danieljurek
Copy link
Member Author

I think that this is something a service team developer should be addressing, not necessarily CXP.

@SatishBoddu-MSFT SatishBoddu-MSFT removed their assignment Feb 10, 2022
@SatishBoddu-MSFT SatishBoddu-MSFT added Service Attention Workflow: This issue is responsible by Azure service team. and removed CXP Attention labels Feb 10, 2022
@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. Mixed Reality needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team Service Attention Workflow: This issue is responsible by Azure service team.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants