Skip to content

fix: correct documentation typos across multiple SDK modules - #50362

Open
Rakesh (ravening) wants to merge 2 commits into
Azure:mainfrom
ravening:fix/documentation-typos
Open

fix: correct documentation typos across multiple SDK modules#50362
Rakesh (ravening) wants to merge 2 commits into
Azure:mainfrom
ravening:fix/documentation-typos

Conversation

@ravening

Copy link
Copy Markdown
Contributor

Description

Fix the typos in the files

  • Fix 'refer call' → 'call' in azure-core and clientcore READMEs
  • Fix 'ContinuablePageFlux' → 'ContinuablePagedFlux' in azure-core README
  • Fix 'fix interval' → 'fixed interval' in azure-core README
  • Fix 'overriden' → 'overridden' in New-TestResources.ps1.md
  • Fix 'it's' → 'its' (possessive) in keyvault and cosmos JavaDoc
  • Fix 'teh' → 'the' in cosmos implementation classes
  • Fix 'occured' → 'occurred' in cosmos retry policies and encryption
  • Fix 'recieved' → 'received' in storage test base classes
  • Fix 'seperate' → 'separated' in cosmos LocationHelper
  • Fix missing 'is' in ETag.java JavaDoc
  • Fix 'it's' → 'its' in ProgressReporter.java JavaDoc

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

- Fix 'refer call' → 'call' in azure-core and clientcore READMEs
- Fix 'ContinuablePageFlux' → 'ContinuablePagedFlux' in azure-core README
- Fix 'fix interval' → 'fixed interval' in azure-core README
- Fix 'overriden' → 'overridden' in New-TestResources.ps1.md
- Fix 'it's' → 'its' (possessive) in keyvault and cosmos JavaDoc
- Fix 'teh' → 'the' in cosmos implementation classes
- Fix 'occured' → 'occurred' in cosmos retry policies and encryption
- Fix 'recieved' → 'received' in storage test base classes
- Fix 'seperate' → 'separated' in cosmos LocationHelper
- Fix missing 'is' in ETag.java JavaDoc
- Fix 'it's' → 'its' in ProgressReporter.java JavaDoc
Copilot AI lite review requested due to automatic review settings September 4, 2026 08:27
@github-actions github-actions Bot added Azure.Core azure-core clientcore Community Contribution Community members are working on the issue Cosmos customer-reported Issues that are reported by GitHub users external to the Azure organization. KeyVault Storage Storage Service (Queues, Blobs, Files) labels Sep 4, 2026
@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Thank you for your contribution Rakesh (@ravening)! We will review the pull request and get back to you soon.

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 2 pipeline(s).
33 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

Changes are limited to documentation/comment/string typos with no expected functional impact, with only a minor best-practice suggestion noted.

Pull request overview

This PR performs typo and grammar corrections across multiple Azure SDK for Java modules (README content, JavaDoc, code comments, and a couple of string literals), improving documentation clarity and developer-facing text without changing functional behavior.

Changes:

  • Corrected common misspellings/grammar in JavaDoc and comments (e.g., “it’s” → “its”, “teh” → “the”, “occured” → “occurred”, “recieved” → “received”).
  • Fixed README wording and class-name references (e.g., ContinuablePageFluxContinuablePagedFlux, “fix interval” → “fixed interval”).
  • Updated a few user-facing/sample/documentation strings for correctness.
File summaries
File Description
sdk/storage/azure-storage-file-share/src/test/java/com/azure/storage/file/share/FileShareTestBase.java Corrected “recieved” → “received” in test JavaDoc.
sdk/storage/azure-storage-file-datalake/src/test/java/com/azure/storage/file/datalake/DataLakeTestBase.java Corrected “recieved” → “received” in test JavaDoc.
sdk/storage/azure-storage-blob/src/test/java/com/azure/storage/blob/BlobTestBase.java Corrected “recieved” → “received” in test JavaDoc.
sdk/storage/azure-storage-blob-cryptography/src/test/java/com/azure/storage/blob/specialized/cryptography/BlobCryptographyTestBase.java Corrected “recieved” → “received” in test JavaDoc.
sdk/storage/azure-storage-blob-batch/src/test/java/com/azure/storage/blob/batch/BlobBatchTestBase.java Corrected “recieved” → “received” in test JavaDoc.
sdk/keyvault/azure-security-keyvault-certificates/src/main/java/com/azure/security/keyvault/certificates/models/ImportCertificateOptions.java Fixed possessive “it’s” → “its” in JavaDoc.
sdk/keyvault/azure-security-keyvault-administration/src/samples/java/com/azure/security/keyvault/administration/AccessControlHelloWorldAsync.java Fixed possessive “it’s” → “its” in sample comment text.
sdk/keyvault/azure-security-keyvault-administration/src/samples/java/com/azure/security/keyvault/administration/AccessControlHelloWorld.java Fixed possessive “it’s” → “its” in sample comment text.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosPatchOperations.java Fixed possessive “it’s” → “its” in JavaDoc.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/RxGatewayStoreModel.java Corrected “teh” → “the” in comment.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/routing/LocationHelper.java Corrected “seperated” → “separated” in comment.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/QueryMetricsUtils.java Corrected “recieved” → “received” in exception message text.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/PartitionKeyRangeGoneRetryPolicy.java Corrected “occured” → “occurred” in comment.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/PartitionKeyMismatchRetryPolicy.java Corrected “occured” → “occurred” in comment.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/MacPool.java Corrected “teh” → “the” in comment.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/http/HttpResponse.java Fixed possessive “it’s” → “its” in JavaDoc.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/changefeed/ChangeFeedContextClient.java Fixed possessive “it’s” → “its” in JavaDoc.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/apachecommons/collections/map/AbstractHashedMap.java Corrected “overriden” → “overridden” in comment.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/CosmosContainer.java Fixed possessive “it’s” → “its” in JavaDoc.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/CosmosAsyncContainer.java Fixed possessive “it’s” → “its” in JavaDoc.
sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/implementation/MacPoolTest.java Corrected “teh” → “the” in test comment.
sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/CosmosContainerChangeFeedTest.java Corrected “teh” → “the” in test comment.
sdk/cosmos/azure-cosmos-encryption/src/main/java/com/azure/cosmos/encryption/implementation/mdesrc/cryptography/MicrosoftDataEncryptionExceptionResource.java Corrected “occured” → “occurred” in resource message.
sdk/cosmos/azure-cosmos-encryption/src/main/java/com/azure/cosmos/encryption/CosmosEncryptionContainer.java Fixed possessive “it’s” → “its” in JavaDoc.
sdk/cosmos/azure-cosmos-encryption/src/main/java/com/azure/cosmos/encryption/CosmosEncryptionAsyncContainer.java Fixed possessive “it’s” → “its” in JavaDoc.
sdk/core/azure-core/src/main/java/com/azure/core/util/ProgressReporter.java Fixed possessive “it’s” → “its” in JavaDoc.
sdk/core/azure-core/src/main/java/com/azure/core/util/ETag.java Fixed missing “is” in JavaDoc sentence.
sdk/core/azure-core/README.md Fixed wording and corrected class name/phrasing in examples section.
sdk/clientcore/core/README.md Fixed wording in examples section.
eng/common/TestResources/New-TestResources.ps1.md Corrected “overriden” → “overridden” in documentation.
Review details
  • Files reviewed: 30/30 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Azure.Core azure-core clientcore Community Contribution Community members are working on the issue Cosmos customer-reported Issues that are reported by GitHub users external to the Azure organization. KeyVault Storage Storage Service (Queues, Blobs, Files)

Projects

Status: Untriaged

Development

Successfully merging this pull request may close these issues.

2 participants