Skip to content

Commit 82c6494

Browse files
authored
Fix typos and grammar in docs (#2759)
1 parent 4a93c15 commit 82c6494

File tree

9 files changed

+17
-17
lines changed

9 files changed

+17
-17
lines changed

docs/GettingStarted.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ install` commands are all you need to build the SDK.
3232

3333
One important thing to note is that if you're working on the [code
3434
generator][codegen], be sure to do a `mvn install` rather than a phase that
35-
comes earlier such as `compile` or `test` so that the build uses the uses the
35+
comes earlier such as `compile` or `test` so that the build uses the
3636
correct code generator JAR (i.e. the one including your changes). When in
3737
doubt, just use `mvn package`.
3838

docs/design/NamingConventions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ This page describes the naming conventions, nouns and common terms
1515
* If the class's primary purpose is to return instances of another class:
1616
* If the "get" method has no parameters:
1717
* If the class implements `Supplier`: `{Noun}Supplier` (e.g. `CachedSupplier`)
18-
* If the class does not implements `Supplier`: `{Noun}Provider` (e.g. `AwsCredentialsProvider`)
19-
* If the "get" method has paramters: `{Noun}Factory` (e.g. `AwsJsonProtocolFactory`)
18+
* If the class does not implement `Supplier`: `{Noun}Provider` (e.g. `AwsCredentialsProvider`)
19+
* If the "get" method has parameters: `{Noun}Factory` (e.g. `AwsJsonProtocolFactory`)
2020

2121
#### Service-specific classes
2222

docs/design/UseOfOptional.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This page describes a general guideline for the use of
1010
- `Optional` SHOULD be used when it is not obvious to a caller whether a
1111
result will be null, e.g, `public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)`in [SdkResponse.java](https://github.com/aws/aws-sdk-java-v2/blob/aa161c564c580ced4a0381d3ed7d4d13120916fc/core/sdk-core/src/main/java/software/amazon/awssdk/core/SdkResponse.java#L59-L61)
1212
- `Optional` MUST NOT be used for "getters" in generated service model classes such as service Builders or POJOs.
13-
- For memember variables: `Optional` SHOULD NOT be used, e.g., `private final Optional<String> field;`
13+
- For member variables: `Optional` SHOULD NOT be used, e.g., `private final Optional<String> field;`
1414
- For method parameters: `Optional` MUST NOT be used, e.g., `private void test(Optional<String> value)`
1515

1616

docs/design/core/metrics/Design.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ standard metrics collected by the SDK.
1313

1414
### Metric Collector
1515

16-
* `MetricCollector` is a typesafe aggregator of of metrics. This is the primary
16+
* `MetricCollector` is a typesafe aggregator of metrics. This is the primary
1717
interface through which other SDK components report metrics they emit, using
1818
the `reportMetric(SdkMetric,Object)` method.
1919

@@ -31,7 +31,7 @@ standard metrics collected by the SDK.
3131
returns an immutable version of the tree formed by the collector and its
3232
children, which are also represented by `MetricCollection` objects.
3333

34-
Note that calling `collect()` implies that child collectors are are also
34+
Note that calling `collect()` implies that child collectors are also
3535
collected.
3636

3737
* Each collector has a name. Often this is will be used to describe the class of
@@ -240,12 +240,12 @@ New modules are created to support metrics feature.
240240
### metrics-publishers
241241
* This is a new module that contains implementations of all SDK supported publishers
242242
* Under this module, a new sub-module is created for each publisher (`cloudwatch-publisher`, `csm-publisher`)
243-
* Customers has to **explicitly add dependency** on these modules to use the sdk provided publishers
243+
* Customers have to **explicitly add dependency** on these modules to use the sdk provided publishers
244244

245245
## Performance
246-
One of the main tenets for metrics is Enabling default metrics should have
246+
One of the main tenets for metrics is "Enabling default metrics should have
247247
minimal impact on the application performance". The following design choices are
248-
made to ensure enabling metrics does not effect performance significantly.
248+
made to ensure enabling metrics does not affect performance significantly.
249249

250250
* When collecting metrics, a No-op metric collector is used if metrics are
251251
disabled. All methods in this collector are no-op and return immediately.

docs/design/core/metrics/MetricsList.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
The set of core metrics includes all metrics collected by the core components
1111
of the SDK. This includes components like SDK service clients,
12-
request/resposne marshallers and unmarshallers, and signers.
12+
request/response marshallers and unmarshallers, and signers.
1313

1414
All the in code constants associated with metric below can be found in the
1515
[`software.amazon.awssdk.core.metrics.CoreMetric`](https://github.com/aws/aws-sdk-java-v2/blob/8c192e3b04892987bf0872f76ba4f65167f3a872/core/sdk-core/src/main/java/software/amazon/awssdk/core/metrics/CoreMetric.java#L24)
@@ -35,7 +35,7 @@ class within `sdk-core`.
3535

3636
The set of HTTP metrics below are collected by components that implement the [HTTP SPI](https://github.com/aws/aws-sdk-java-v2/tree/sdk-metrics-development-2/http-client-spi). Which metrics are collected depends on the specific HTTP library used to implement the SPI; not all libraries will allow the collection of every metric below.
3737

38-
Note that in the context of an SDK client API call, all `HttpClient` collectors are children of `ApiCallAttept`; i.e. the full path to HTTP client metrics for an individual API call attempt is `ApiCall` > `ApiCallAttept` > `HttpClient`.
38+
Note that in the context of an SDK client API call, all `HttpClient` collectors are children of `ApiCallAttempt`; i.e. the full path to HTTP client metrics for an individual API call attempt is `ApiCall` > `ApiCallAttept` > `HttpClient`.
3939

4040
### Common HTTP Metrics
4141

docs/design/core/presigners/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ public interface GetObjectPresignRequest extends PresignRequest {
226226

227227
public interface PresignRequest {
228228
/**
229-
* The duration for which this presigned request should be valid. After this time has expird,
229+
* The duration for which this presigned request should be valid. After this time has expired,
230230
* attempting to use the presigned request will fail.
231231
*/
232232
Duration signatureDuration();

docs/design/core/waiters/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,10 @@ Waiter<DescribeTableResponse> waiter =
8282
.overrideConfiguration(p -> p.maxAttemps(20).backoffStrategy(BackoffStrategy.defaultStrategy())
8383
.build();
8484

85-
// run synchronousely
85+
// run synchronously
8686
WaiterResponse<DescribeTableResponse> response = waiter.run(() -> client.describeTable(describeTableRequest));
8787

88-
// run asychronousely
88+
// run asynchronously
8989
CompletableFuture<WaiterResponse<DescribeTableResponse>> responseFuture =
9090
waiter.runAsync(() -> asyncClient.describeTable(describeTableRequest));
9191
```

docs/design/services/s3/transfermanager/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ S3 `S3TransferManager`, a high level library built on the S3 client.
4545
* The size of resources used by Transfermanager and configured by the user
4646
should not affect its stability.
4747

48-
For example, the configured size of a threadpool should be irellevant to its
49-
ability to successfuly perform an operation.
48+
For example, the configured size of a threadpool should be irrelevant to its
49+
ability to successfully perform an operation.
5050

5151
Ref: https://github.com/aws/aws-sdk-java/issues/939
5252

docs/design/services/s3/transfermanager/listener/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Internally, `TransferManager` uses its own implementation of a `ProgressListener
9595

9696
## Java SDK v2 Background
9797

98-
While v2 does not currently support the concept of a `ProgressListener`, it does make extensive use of `ExecutionInterceptor`s, which offers some similar functionality. The `ExecutionInterceptor` interface is an implementation of the [intercepting filter design pattern](https://en.wikipedia.org/wiki/Intercepting_filter_pattern), which offers an composable way to respond to different events and apply resulting transformations. The key difference here is that `ExecutionInterceptor`s tend to be targeted towards mutating operations, and the interface method names further reinforce this, e.g.: `modifyRequest`, `modifyHttpContent`, etc.
98+
While v2 does not currently support the concept of a `ProgressListener`, it does make extensive use of `ExecutionInterceptor`s, which offers some similar functionality. The `ExecutionInterceptor` interface is an implementation of the [intercepting filter design pattern](https://en.wikipedia.org/wiki/Intercepting_filter_pattern), which offers a composable way to respond to different events and apply resulting transformations. The key difference here is that `ExecutionInterceptor`s tend to be targeted towards mutating operations, and the interface method names further reinforce this, e.g.: `modifyRequest`, `modifyHttpContent`, etc.
9999

100100
The v2 `ExecutionInterceptor` interface can be summarized as follows:
101101

0 commit comments

Comments
 (0)