Skip to content

Commit 35593b9

Browse files
committed
docs: fix incorrect indefinite article "a" to "an" before vowel-sound acronyms
Fix incorrect usage of the indefinite article "a" before words and acronyms that begin with a vowel sound. English grammar requires "an" before vowel sounds, including acronyms like S3 ("ess"), SNS, SQS, API, AWS, Amazon, EC2, ECS, EBS, and IAM. Examples of fixes: - "a S3 bucket" → "an S3 bucket" - "a SNS topic" → "an SNS topic" - "a API Gateway" → "an API Gateway" - "a AWS lambda" → "an AWS lambda" - "a ECS container" → "an ECS container"
1 parent 4fd0002 commit 35593b9

File tree

33 files changed

+53
-53
lines changed

33 files changed

+53
-53
lines changed

packages/@aws-cdk/aws-amplify-alpha/lib/branch.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ export interface BranchOptions {
111111
* Asset for deployment.
112112
*
113113
* The Amplify app must not have a sourceCodeProvider configured as this resource uses Amplify's
114-
* startDeployment API to initiate and deploy a S3 asset onto the App.
114+
* startDeployment API to initiate and deploy an S3 asset onto the App.
115115
*
116116
* @default - no asset
117117
*/

packages/@aws-cdk/aws-glue-alpha/lib/s3-table.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ export interface S3TableProps extends TableBaseProps {
8282
}
8383

8484
/**
85-
* A Glue table that targets a S3 dataset.
85+
* A Glue table that targets an S3 dataset.
8686
* @resource AWS::Glue::Table
8787
*/
8888
@propertyInjectable

packages/@aws-cdk/aws-iotevents-alpha/lib/action.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export interface IAction {
2424
}
2525

2626
/**
27-
* Properties for a AWS IoT Events action
27+
* Properties for an AWS IoT Events action
2828
*/
2929
export interface ActionConfig {
3030
/**

packages/aws-cdk-lib/aws-apigatewayv2/lib/common/api.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import type { IResource } from '../../../core';
33
import type { IApiRef } from '../apigatewayv2.generated';
44

55
/**
6-
* Represents a API Gateway HTTP/WebSocket API
6+
* Represents an API Gateway HTTP/WebSocket API
77
*/
88
export interface IApi extends IResource, IApiRef {
99
/**

packages/aws-cdk-lib/aws-chatbot/lib/slack-channel-configuration.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ export class SlackChannelConfiguration extends SlackChannelConfigurationBase {
340340
}
341341

342342
/**
343-
* Adds a SNS topic that deliver notifications to AWS Chatbot.
343+
* Adds an SNS topic that deliver notifications to AWS Chatbot.
344344
*/
345345
@MethodMetadata()
346346
public addNotificationTopic(notificationTopic: sns.ITopic): void {

packages/aws-cdk-lib/aws-cloudfront-origins/lib/s3-bucket-origin.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ const KEY_ACTIONS: Record<string, string[]> = {
3131
export interface S3BucketOriginBaseProps extends cloudfront.OriginProps { }
3232

3333
/**
34-
* Properties for configuring a S3 origin with OAC
34+
* Properties for configuring an S3 origin with OAC
3535
*/
3636
export interface S3BucketOriginWithOACProps extends S3BucketOriginBaseProps {
3737
/**
@@ -51,7 +51,7 @@ export interface S3BucketOriginWithOACProps extends S3BucketOriginBaseProps {
5151
}
5252

5353
/**
54-
* Properties for configuring a S3 origin with OAI
54+
* Properties for configuring an S3 origin with OAI
5555
*/
5656
export interface S3BucketOriginWithOAIProps extends S3BucketOriginBaseProps {
5757
/**
@@ -67,14 +67,14 @@ export interface S3BucketOriginWithOAIProps extends S3BucketOriginBaseProps {
6767
*/
6868
export abstract class S3BucketOrigin extends cloudfront.OriginBase {
6969
/**
70-
* Create a S3 Origin with Origin Access Control (OAC) configured
70+
* Create an S3 Origin with Origin Access Control (OAC) configured
7171
*/
7272
public static withOriginAccessControl(bucket: IBucket, props?: S3BucketOriginWithOACProps): cloudfront.IOrigin {
7373
return new S3BucketOriginWithOAC(bucket, props);
7474
}
7575

7676
/**
77-
* Create a S3 Origin with Origin Access Identity (OAI) configured
77+
* Create an S3 Origin with Origin Access Identity (OAI) configured
7878
* OAI is a legacy feature and we **strongly** recommend you to use OAC via `withOriginAccessControl()`
7979
* unless it is not supported in your required region (e.g. China regions).
8080
*/
@@ -83,7 +83,7 @@ export abstract class S3BucketOrigin extends cloudfront.OriginBase {
8383
}
8484

8585
/**
86-
* Create a S3 Origin with default S3 bucket settings (no origin access control)
86+
* Create an S3 Origin with default S3 bucket settings (no origin access control)
8787
*/
8888
public static withBucketDefaults(bucket: IBucket, props?: cloudfront.OriginProps): cloudfront.IOrigin {
8989
return new class extends S3BucketOrigin {

packages/aws-cdk-lib/aws-cloudfront-origins/lib/s3-origin.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export class S3Origin implements cloudfront.IOrigin {
4444
}
4545

4646
/**
47-
* An Origin specific to a S3 bucket (not configured for website hosting).
47+
* An Origin specific to an S3 bucket (not configured for website hosting).
4848
*
4949
* Contains additional logic around bucket permissions and origin access identities.
5050
*/

packages/aws-cdk-lib/aws-cloudfront-origins/lib/s3-static-website-origin.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ import * as cloudfront from '../../aws-cloudfront';
44
import type { IBucket } from '../../aws-s3';
55

66
/**
7-
* Properties for configuring a origin using a S3 bucket configured as a website endpoint
7+
* Properties for configuring a origin using an S3 bucket configured as a website endpoint
88
*/
99
export interface S3StaticWebsiteOriginProps extends HttpOriginProps { }
1010

1111
/**
12-
* An Origin for a S3 bucket configured as a website endpoint
12+
* An Origin for an S3 bucket configured as a website endpoint
1313
*/
1414
export class S3StaticWebsiteOrigin extends HttpOrigin {
1515
constructor(bucket: IBucket, props?: S3StaticWebsiteOriginProps) {

packages/aws-cdk-lib/aws-cloudfront/lib/origin-access-control.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ export enum AccessLevel {
7070
}
7171

7272
/**
73-
* Properties for creating a S3 Origin Access Control resource.
73+
* Properties for creating an S3 Origin Access Control resource.
7474
*/
7575
export interface S3OriginAccessControlProps extends OriginAccessControlBaseProps { }
7676

packages/aws-cdk-lib/aws-cloudwatch/lib/graph.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1005,7 +1005,7 @@ export interface CustomWidgetProps {
10051005
}
10061006

10071007
/**
1008-
* A CustomWidget shows the result of a AWS lambda function
1008+
* A CustomWidget shows the result of an AWS lambda function
10091009
*/
10101010
export class CustomWidget extends ConcreteWidget {
10111011
private readonly props: CustomWidgetProps;

0 commit comments

Comments
 (0)