Fix typos and linguistic errors in documentation / hacktoberfest

CONTRIBUTING.md

@@ -11,7 +11,7 @@ Thank you for your interest in contributing to Azure SDK for Java.
 
 - After cloning the repo, copy the [pre-commit hooks file](https://github.com/Azure/azure-sdk-for-java/tree/main/eng/scripts/pre-commit) (located at `eng/scripts/pre-commit`) to your local `.git/hooks/` directory. This will run some validations before your changes are committed.
 
-- Refer to the [wiki](https://github.com/Azure/azure-sdk-for-java/wiki/Building#testing-for-spotbugs-and-checkstyle-issues) to learn about how Azure SDK for java generates CheckStyle, SpotBugs, Jacoco, and JavaDoc reports.
+- Refer to the [wiki](https://github.com/Azure/azure-sdk-for-java/wiki/Building#testing-for-spotbugs-and-checkstyle-issues) to learn about how Azure SDK for Java generates CheckStyle, SpotBugs, Jacoco, and JavaDoc reports.
 
 - There are two Maven projects in the repo. Refer to the [wiki](https://github.com/Azure/azure-sdk-for-java/wiki/Building#pomclientxml-vs-pomdataxml) to learn about project structure for each.
 

SUPPORT.md

@@ -25,7 +25,7 @@ To ensure the relevance and manageability of our issue queue, we have an automat
 - Ask a question at [Microsoft Tech Community](https://techcommunity.microsoft.com/t5/azure/ct-p/Azure)
 
 ### Security bugs
-Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center([email protected]). 
+Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center ([email protected]). 
 You should receive a response within 24 hours. 
 Further information, including the MSRC PGP key, can be found in the [Security TechCenter](https://www.microsoft.com/msrc/faqs-report-an-issue?rtc=1)
 

common/perf-test-core/src/main/java/com/azure/perf/test/core/ApiPerfTestBase.java

@@ -65,7 +65,7 @@ public abstract class ApiPerfTestBase<TOptions extends PerfStressOptions> extend
      * Creates an instance of the Http Based Performance test.
      *
      * @param options the performance test options to use while running the test.
-     * @throws IllegalStateException if an errors is encountered with building ssl context.
+     * @throws IllegalStateException if an error is encountered with building ssl context.
      */
     public ApiPerfTestBase(TOptions options) {
         super(options);
@@ -462,7 +462,7 @@ private Mono<Void> startPlaybackAsync() {
     /**
      * Records responses and starts tests in playback mode.
      *
-     * @return
+     * @return An empty {@link Mono}.
      */
     @Override
     Mono<Void> postSetupAsync() {

common/perf-test-core/src/main/java/com/azure/perf/test/core/MockBatchReceiverTest.java

@@ -61,7 +61,7 @@ public int getMaxMessageCount() {
 
         /**
          * Get the Min Message count.
-         * @return the Min
+         * @return the minimum message count
          */
         public int getMinMessageCount() {
             return minMessageCount;

common/perf-test-core/src/main/java/com/azure/perf/test/core/PerfStressProgram.java

@@ -58,7 +58,7 @@ private static double getOperationsPerSecond(PerfTestBase<?>[] tests) {
      * Runs the performance tests passed to be executed.
      *
      * @param classes the performance test classes to execute.
-     * @param args the command line arguments ro run performance tests with.
+     * @param args the command line arguments to run performance tests with.
      * @throws RuntimeException if the execution fails.
      */
     public static void run(Class<?>[] classes, String[] args) {
@@ -111,7 +111,7 @@ private static String getCommandName(String testName) {
      * Run the performance test passed to be executed.
      *
      * @param testClass the performance test class to execute.
-     * @param options the configuration ro run performance test with.
+     * @param options the configuration to run performance test with.
      * @throws RuntimeException if the execution fails.
      */
     public static void run(Class<?> testClass, PerfStressOptions options) {
@@ -257,12 +257,12 @@ private static void writeKeyValue(String key, Object value, StringBuilder sb, At
      * Runs the performance tests passed to be executed.
      *
      * @param tests the performance tests to be executed.
-     * @param sync indicate if synchronous test should be run.
-     * @param completableFuture indicate if completable future test should be run.
-     * @param executorService indicate if executor service test should be run.
-     * @param virtualThread indicate if virtual thread test should be run.
+     * @param sync indicates if synchronous test should be run.
+     * @param completableFuture indicates if completable future test should be run.
+     * @param executorService indicates if executor service test should be run.
+     * @param virtualThread indicates if virtual thread test should be run.
      * @param parallel the number of parallel threads to run the performance test on.
-     * @param durationSeconds the duration for which performance test should be run on.
+     * @param durationSeconds the duration for which performance test should be run for.
      * @param title the title of the performance tests.
      *
      * @throws RuntimeException if the execution fails.
@@ -307,7 +307,7 @@ public static void runTests(PerfTestBase<?>[] tests, boolean sync, boolean compl
                     = CompletableFuture.allOf(futures.toArray(new CompletableFuture<?>[0]));
                 allFutures.get(); // Wait for all futures to complete
             } else if (executorService) {
-                // when updated to concurrentTaskLimit, the performance drops?
+                // When updated to concurrentTaskLimit, the performance drops.
                 ExecutorService executor = Executors.newFixedThreadPool(tests.length);
                 try {
                     for (PerfTestBase<?> test : tests) {
@@ -358,7 +358,7 @@ public static void runTests(PerfTestBase<?>[] tests, boolean sync, boolean compl
 
         long totalOperations = getCompletedOperations(tests);
         if (totalOperations == 0) {
-            throw new IllegalStateException("Zero operations has been completed");
+            throw new IllegalStateException("Zero operations have been completed");
         }
         double operationsPerSecond = getOperationsPerSecond(tests);
         double secondsPerOperation = 1 / operationsPerSecond;

common/perf-test-core/src/main/java/com/azure/perf/test/core/TestDataCreationHelper.java

@@ -119,7 +119,7 @@ public static long copyStream(InputStream inputStream, OutputStream outputStream
     }
 
     /**
-     * Generate random string of given {@code targetLength length}. The string will only have lower case alphabets.
+     * Generate random string of given {@code targetLength}. The string will only have lower case alphabets.
      *
      * @param targetLength of the string to be generated.
      * @return the generated string.
@@ -139,7 +139,7 @@ public static String generateRandomString(int targetLength) {
     /**
      * Writes contents of the specified size to the specified file path.
      *
-     * @param filePath the path of the file to write to contents to
+     * @param filePath the path of the file to write contents to
      * @param size the size of the contents to write to the file.
      * @param bufferSize the size of the buffer to use to write to the file.
      * @throws IOException when an error occurs when writing to the file.

common/perf-test-core/src/main/java/com/azure/perf/test/core/TestProxyPolicy.java

@@ -102,7 +102,7 @@ private void redirectToTestProxy(HttpRequest request) {
 
     @Override
     public HttpPipelinePosition getPipelinePosition() {
-        // The policy should be ran per retry in case calls are made to a secondary, fail-over host.
+        // The policy should be run per retry in case calls are made to a secondary, fail-over host.
         return HttpPipelinePosition.PER_RETRY;
     }
 }

eng/automation/changelog/src/main/java/com/azure/resourcemanager/tools/changelog/changelog/DefinitionStageChangeLog.java

@@ -40,7 +40,7 @@ public class DefinitionStageChangeLog extends ChangeLog {
      *
      * @param blankStage The start point for BFS, which is the first stage.
      * @param stageToMethods contains all stages. Map from Stage name to all methods it has.
-     * @param getReturnType The function to map a JApiMethod to its according return type, which is the next stage name.
+     * @param getReturnType The function to map a JApiMethod to its corresponding return type, which is the next stage name.
      * @param resultForMethodsByStageIndex The result contains list of methods. The index represents which stage the method locates.
      */
     private void calcMethodStages(AllMethods blankStage, Map<String, AllMethods> stageToMethods, Function<JApiMethod, String> getReturnType, List<Set<JApiMethod>> resultForMethodsByStageIndex) {

eng/bomgenerator/readme.md

@@ -9,12 +9,12 @@ Arguments to run the tool in this mode.
 		 2. The BOM file which is the initial POM file.
 		 3. InputDependencies file to override the inputs from the version_client.txt. This is an optional file.
 
-        -outputDir=<location_of_outputput_directory>
+        -outputDir=<location_of_output_directory>
         This generates the following files in the location.
 		1. Report log.
 		2. Newly created BOM file
 
-2. Analyze mode - When run in this mode the tool validates the BOM. 
+2. Analyze mode - When run in this mode the tool validates the BOM.
 Arguments to run the tool in this mode.
-        -mode=analyze -inputDir=<location_to_inputDir)>
+        -mode=analyze -inputDir=<location_to_inputDir>
 		This location includes the pom file for the BOM or any library.

eng/common/TestResources/README.md

@@ -5,7 +5,7 @@ in Azure. Service directories that include a `test-resources.json` or `test-reso
 file require running [New-TestResources.ps1][] to create these resources and output
 environment variables you must set.
 
-The following scripts can be used both in on your desktop for developer
+The following scripts can be used both on your desktop for developer
 scenarios as well as on hosted agents for continuous integration testing.
 
 * [New-TestResources.ps1][] - Creates new test resources for a given service.

eng/containers/README.md

@@ -10,7 +10,7 @@ This folder contains dockerfiles for private container images used in Azure SDKs
    * `docker build . -t {registry}/java-tools/mvn:{new tag} -f jdk-mariner-mvn-dockerfile --build-arg MAVEN_VERSION={new version}`
      * Supported parameters:
        * `OPEN_JDK_MARINER_TAG`: one of the [JDK Mariner image tags](https://learn.microsoft.com/java/openjdk/containers#linux-based-images)
-       * `MAVEN_VERSION`: specifies verssion to download Maven from `https://apache.osuosl.org/maven/maven-3/${MAVEN_VERSION}/binaries/apache-maven-${MAVEN_VERSION}-bin.tar.gz`
+       * `MAVEN_VERSION`: specifies version to download Maven from `https://apache.osuosl.org/maven/maven-3/${MAVEN_VERSION}/binaries/apache-maven-${MAVEN_VERSION}-bin.tar.gz`
        * `MAVEN_URL`: override full URL to download `maven*.tar.gz` from.
    * `{new tag}` should contain JDK and maven versions. Follow the `jdk11-mvn3.9.5` naming pattern.
 

samples/azure-samples-graalvm-spring-storageexplorer/src/main/java/com/azure/samples/graalvm/spring/storageexplorer/storage/StorageService.java

@@ -11,7 +11,7 @@
 public interface StorageService {
 
     /**
-     * This method is called once when the web app starts to allow for initialisation of resources.
+     * This method is called once when the web app starts to allow for initialization of resources.
      */
     void init();
 
@@ -27,7 +27,7 @@ public interface StorageService {
     /**
      * This method returns a stream of all files stored in the storage service.
      *
-     * @return
+     * @return A stream of all files stored in the storage service.
      */
     Stream<StorageItem> listAllFiles();
 

sdk/appconfiguration/azure-data-appconfiguration/TROUBLESHOOTING.md

@@ -1,8 +1,8 @@
 # Troubleshooting App Configuration issues
 
-This troubleshooting guide covers failure investigation techniques, common errors for the credential types in the Azure 
-App Configuration Java client library, and mitigation steps to resolve these errors. The frequently asked question can 
-be found in [FAQ][faq] and common best practice sample can be found in [Best Practice Samples][best_practice_samples].
+This troubleshooting guide covers failure investigation techniques, common errors for the credential types in the Azure
+App Configuration Java client library, and mitigation steps to resolve these errors. Frequently asked questions can
+be found in [FAQ][faq] and common best practice samples can be found in [Best Practice Samples][best_practice_samples].
 
 ## Table of Contents
 

sdk/communication/azure-communication-identity/README.md

@@ -127,7 +127,7 @@ also takes in a list of `CommunicationTokenScope`. Scope options include:
 - `CHAT` (Use this for full access to Chat APIs)
 - `VOIP` (Use this for full access to Calling APIs)
 - `CHAT_JOIN` (Access to Chat APIs but without the authorization to create, delete or update chat threads)
-- `CHAT_JOIN_LIMITED` (A more limited version of CHAT_JOIN that doesn't allow to add or remove participants)
+- `CHAT_JOIN_LIMITED` (A more limited version of CHAT_JOIN that doesn't allow adding or removing participants)
 - `VOIP_JOIN` (Access to Calling APIs but without the authorization to start new calls)
 
 ```java readme-sample-issueUserToken

sdk/storage/CONTRIBUTING.md

@@ -9,7 +9,7 @@ Thank you for your interest in contributing to Azure SDK for Java.
 
 - To make code changes, or contribute something new, please follow the [GitHub Forks / Pull requests model](https://help.github.com/articles/fork-a-repo/): Fork the repo, make the change and propose it back by submitting a pull request.
 
-- Refer to the [wiki](https://github.com/Azure/azure-sdk-for-java/wiki/Building#testing-for-spotbugs-and-checkstyle-issues) to learn about how Azure SDK for java generates CheckStyle, SpotBugs, Jacoco, and JavaDoc reports.
+- Refer to the [wiki](https://github.com/Azure/azure-sdk-for-java/wiki/Building#testing-for-spotbugs-and-checkstyle-issues) to learn about how Azure SDK for Java generates CheckStyle, SpotBugs, Jacoco, and JavaDoc reports.
 
 - There are two Maven projects in the repo. Refer to the [wiki](https://github.com/Azure/azure-sdk-for-java/wiki/Building#pomclientxml-vs-pomdataxml) to learn about project structure for each.