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

cognitiveservices/azure-cognitiveservices-search-entitysearch - cspell found spelling errors in public API surface #22706

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

Comments

@danieljurek
Copy link
Member

Spell check scanning of package at sdk/cognitiveservices/azure-cognitiveservices-search-entitysearch detected spelling errors in the public API surface. 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/cognitiveservices/azure-cognitiveservices-search-entitysearch/**. 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/cognitiveservices/azure-cognitiveservices-search-entitysearch/**"
  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/cognitiveservices/azure-cognitiveservices-search-entitysearch/azure/cognitiveservices/search/entitysearch/operations/_entities_operations.py:190:68 - Unknown word (JSONLD)
./sdk/cognitiveservices/azure-cognitiveservices-search-entitysearch/azure/cognitiveservices/search/entitysearch/operations/_entities_operations.py:191:42 - Unknown word (JSONLD)
./sdk/cognitiveservices/azure-cognitiveservices-search-entitysearch/CHANGELOG.md:57:19 - Unknown word (prefered)
./sdk/cognitiveservices/azure-cognitiveservices-search-entitysearch/tests/test_entity_search.py:23:60 - Unknown word (Apim)
@danieljurek danieljurek added Client This issue points to a problem in the data-plane of the library. Cognitive Services labels Jan 21, 2022
azure-sdk pushed a commit to azure-sdk/azure-sdk-for-python that referenced this issue Mar 15, 2023
Merge release sentinel 2023 03 01 preview (Azure#22983)

* Adds base for updating Microsoft.SecurityInsights from version preview/2023-02-01-preview to version 2023-03-01-preview

* Updates readme

* Updates API version in new specs and examples

* Update description of AAD (Azure#22508)

* Update description of AAD

AAD should be AADIP to prevent mistakes from customer

* Add custom word AADIP 

AADIP = Azure Active Directory Identity Protection

* Remove bing phishing feed msti connector (Azure#22706)

* remove bing phishing feed from msti connector

* revert to release-Sentinel-2023-03-01-preview

* fixes

* fixed validation issues

* renamed example file

* added response status codes for examples

* Automation rules - 2023-03-01-preview - add entity trigger API (Azure#22523)

* adjust version order

* Fix cross-version breaking changes.

Fix cross-version breaking changes.

* Pull in metadata changes from stable version.

* Update Metadata.json

* Update Incidents.json

add readonly flag for providerIncidentId.

* Update readme.md

GuidUsage AutoRest-Linter suppression.

* Update readme.md

suppress GuidUsage

* Update readme.md

Correct suppression.

* Update readme.md

Fix suppression.

---------

Co-authored-by: shschwar <[email protected]>
Co-authored-by: aviyerMSFT <[email protected]>
Co-authored-by: loriatarms <[email protected]>
@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. Cognitive Services
Projects
None yet
Development

No branches or pull requests

1 participant