-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Fix typos and linguistic errors in documentation / hacktoberfest #46977
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
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Sebastien Dionne <[email protected]>
Thank you for your contribution @survivant! We will review the pull request and get back to you soon. |
@microsoft-github-policy-service agree |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR fixes various typos and linguistic errors across documentation files throughout the Azure SDK for Java repository. It addresses spelling mistakes, grammatical issues, and incomplete documentation.
Key changes include:
- Corrected capitalization of "Java" in several documentation references
- Fixed grammatical errors and improved sentence clarity
- Completed incomplete JavaDoc return statements
- Fixed various spelling mistakes throughout the codebase
Reviewed Changes
Copilot reviewed 14 out of 15 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
sdk/storage/CONTRIBUTING.md | Capitalized "java" to "Java" in documentation reference |
sdk/communication/azure-communication-identity/README.md | Improved grammar in CHAT_JOIN_LIMITED scope description |
sdk/appconfiguration/azure-data-appconfiguration/TROUBLESHOOTING.md | Fixed grammatical errors in introduction paragraph |
samples/azure-samples-graalvm-spring-storageexplorer/src/main/java/com/azure/samples/graalvm/spring/storageexplorer/storage/StorageService.java | Fixed spelling of "initialization" and completed JavaDoc return statement |
eng/containers/README.md | Fixed spelling of "version" |
eng/common/TestResources/README.md | Corrected grammar by removing extra "in" |
eng/bomgenerator/readme.md | Fixed typos in directory paths and removed extra parenthesis |
eng/automation/changelog/src/main/java/com/azure/resourcemanager/tools/changelog/changelog/DefinitionStageChangeLog.java | Improved word choice from "according" to "corresponding" |
common/perf-test-core/src/main/java/com/azure/perf/test/core/TestProxyPolicy.java | Fixed verb tense from "ran" to "run" |
common/perf-test-core/src/main/java/com/azure/perf/test/core/TestDataCreationHelper.java | Fixed JavaDoc parameter references and preposition usage |
common/perf-test-core/src/main/java/com/azure/perf/test/core/PerfStressProgram.java | Fixed multiple typos and grammatical errors in JavaDoc and comments |
common/perf-test-core/src/main/java/com/azure/perf/test/core/MockBatchReceiverTest.java | Completed JavaDoc return statement |
common/perf-test-core/src/main/java/com/azure/perf/test/core/ApiPerfTestBase.java | Fixed plural form and completed JavaDoc return statement |
CONTRIBUTING.md | Capitalized "java" to "Java" in documentation reference |
Signed-off-by: Sebastien Dionne <[email protected]>
if you want can you add this label to this PR : hacktoberfest-accepted :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM for mgmt libs, as long as CI is green.
/* | ||
* Specifies if the billing account for the subscription is transitioned from a Microsoft Online Service Program to | ||
* a Microsoft Customer Agreement (MCA) account. Will be present and value will be true if its a transitioned | ||
* a Microsoft Customer Agreement (MCA) account. Will be present and value will be true if it's a transitioned |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Many of the code was generated from some source, e.g. here via
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingProperty.json#L439
The next release would likely override the fixes here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
humm, I could try to create a PR in the other project too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's try with this: Azure/azure-rest-api-specs#38102
Description
Fix typos and linguistic errors in documentation. It's not much, but I'm happy to help
Please add an informative description that covers that changes made by the pull request and link all relevant issues.
If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.
All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines