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

@azure/core-amqp - cspell found spelling errors in public API surface #18964

Closed
danieljurek opened this issue Dec 6, 2021 · 0 comments
Closed
Assignees
Labels
Client This issue points to a problem in the data-plane of the library.
Milestone

Comments

@danieljurek
Copy link
Member

Spell check scanning of package at sdk/core/core-amqp detected spelling errors in the public API surface. This directory is opted out of PR spell checking in PR #17142 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/core/core-amqp/review/**/*.md. 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/core/core-amqp/review/**/*.md"
  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/core/core-amqp/review/core-amqp.api.md:577:5 - Unknown word (EHOSTDOWN)
./sdk/core/core-amqp/review/core-amqp.api.md:585:5 - Unknown word (ENONET)
./sdk/core/core-amqp/review/core-amqp.api.md:595:47 - Unknown word (sastoken)
@danieljurek danieljurek added the Client This issue points to a problem in the data-plane of the library. label Dec 6, 2021
@JonathanCrd JonathanCrd added this to the [2022] March milestone Feb 10, 2022
@JonathanCrd JonathanCrd mentioned this issue Feb 10, 2022
3 tasks
azure-sdk pushed a commit to azure-sdk/azure-sdk-for-js that referenced this issue Jun 9, 2022
Fix examples for compute default tag:package-2021-12-01 (Azure#18964)

* Fix examples for compute default tag:package-2021-12-01

* true replace false
@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.
Projects
None yet
Development

No branches or pull requests

2 participants