Skip to content

Commit 7a0e9ed

Browse files
authored
chore: fix assorted spelling errors in documentation comments (#37363)
### Reason for this change Fix various misspellings in JSDoc comments and code comments. ### Description of changes - `Wether` → `Whether` (aws-servicecatalog) - `reqeust` → `request` (aws-elasticloadbalancingv2) - `notifyOnPullRequstCreated` → `notifyOnPullRequestCreated` (aws-codecommit) - `permisions` → `permissions` (aws-cloudtrail) - `guarentee` → `guarantee` (core) ### Description of how you validated changes Comment-only changes. No functional impact. ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)
1 parent d12754f commit 7a0e9ed

File tree

7 files changed

+7
-7
lines changed

7 files changed

+7
-7
lines changed

packages/aws-cdk-lib/aws-batch/lib/scheduling-policy.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ export class FairshareSchedulingPolicy extends SchedulingPolicyBase implements I
205205
public static readonly PROPERTY_INJECTION_ID: string = 'aws-cdk-lib.aws-batch.FairshareSchedulingPolicy';
206206

207207
/**
208-
* Reference an exisiting Scheduling Policy by its ARN
208+
* Reference an existing Scheduling Policy by its ARN
209209
*/
210210
public static fromFairshareSchedulingPolicyArn(scope: Construct, id: string, fairshareSchedulingPolicyArn: string): IFairshareSchedulingPolicy {
211211
const stack = Stack.of(scope);

packages/aws-cdk-lib/aws-certificatemanager/lib/dns-validated-certificate.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ export class DnsValidatedCertificate extends CertificateBase implements ICertifi
157157
Region: props.region,
158158
Route53Endpoint: props.route53Endpoint,
159159
RemovalPolicy: cdk.Lazy.any({ produce: () => this._removalPolicy }),
160-
// Custom resources properties are always converted to strings; might as well be explict here.
160+
// Custom resources properties are always converted to strings; might as well be explicit here.
161161
CleanupRecords: props.cleanupRoute53Records ? 'true' : undefined,
162162
Tags: cdk.Lazy.list({ produce: () => this.tags.renderTags() }),
163163
},

packages/aws-cdk-lib/aws-cloudtrail/lib/cloudtrail.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ export interface TrailProps {
120120

121121
/** The Amazon S3 bucket
122122
*
123-
* @default - if not supplied a bucket will be created with all the correct permisions
123+
* @default - if not supplied a bucket will be created with all the correct permissions
124124
*/
125125
readonly bucket?: s3.IBucket;
126126

packages/aws-cdk-lib/aws-codecommit/lib/repository.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ export interface IRepository extends IResource, notifications.INotificationRuleS
137137
* events specified by you are emitted. Similar to `onEvent` API.
138138
*
139139
* You can also use the methods to define rules for the specific event emitted.
140-
* eg: `notifyOnPullRequstCreated`.
140+
* e.g. `notifyOnPullRequestCreated`.
141141
*
142142
* @returns CodeStar Notifications rule associated with this repository.
143143
*/

packages/aws-cdk-lib/aws-elasticloadbalancingv2/lib/alb/conditions.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ class HttpHeaderListenerCondition extends ListenerCondition {
120120
}
121121

122122
/**
123-
* HTTP reqeust method config of the listener rule condition
123+
* HTTP request method config of the listener rule condition
124124
*/
125125
class HttpRequestMethodListenerCondition extends ListenerCondition {
126126
constructor(public readonly values: string[]) {

packages/aws-cdk-lib/aws-servicecatalog/lib/constraints.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export interface StackSetsConstraintOptions extends CommonConstraintOptions {
4747
readonly executionRoleName: string;
4848

4949
/**
50-
* Wether to allow end users to create, update, and delete stacks.
50+
* Whether to allow end users to create, update, and delete stacks.
5151
*
5252
* @default false
5353
*/

packages/aws-cdk-lib/core/lib/cfn-fn.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ export class Fn {
232232
/**
233233
* The intrinsic function ``Fn::FindInMap`` returns the value corresponding to
234234
* keys in a two-level map that is declared in the Mappings section.
235-
* Warning: do not use with lazy mappings as this function will not guarentee a lazy mapping to render in the template.
235+
* Warning: do not use with lazy mappings as this function will not guarantee a lazy mapping to render in the template.
236236
* Prefer to use `CfnMapping.findInMap` in general.
237237
* @returns a token represented as a string
238238
*/

0 commit comments

Comments
 (0)