Skip to content

Commit d981af1

Browse files
iankhougithub-actions
iankhou
and
github-actions
authored
chore(toolkit-lib): formatting and grammar changes in TSDoc comments (#582)
- Default values are either represented as values or as text - i.e. any default value beginning with "- " are meant to be text, while any that do not begin with this prefix are values - Capitalize all default value text entries --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license --------- Signed-off-by: github-actions <[email protected]> Co-authored-by: github-actions <[email protected]>
1 parent 764a12c commit d981af1

File tree

22 files changed

+45
-45
lines changed

22 files changed

+45
-45
lines changed

‎packages/@aws-cdk/toolkit-lib/lib/actions/bootstrap/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ export interface BootstrapParameters {
152152
* Identifier to distinguish multiple bootstrapped environments
153153
* The default qualifier is an arbitrary but unique string
154154
*
155-
* @default - 'hnb659fds'
155+
* @default 'hnb659fds'
156156
*/
157157
readonly qualifier?: string;
158158

‎packages/@aws-cdk/toolkit-lib/lib/actions/deploy/index.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,14 @@ export interface HotswapDeployment {
5050
* Represents configuration property overrides for hotswap deployments.
5151
* Currently only supported by ECS.
5252
*
53-
* @default - no overrides
53+
* @default - No overrides
5454
*/
5555
readonly properties?: HotswapProperties;
5656

5757
/**
5858
* Fall back to a CloudFormation deployment when a non-hotswappable change is detected
5959
*
60-
* @default - do not fall back to a CloudFormation deployment
60+
* @default - Do not fall back to a CloudFormation deployment
6161
*/
6262
readonly fallback?: DirectDeployment | ChangeSetDeployment;
6363
}
@@ -115,7 +115,7 @@ export interface BaseDeployOptions {
115115
/**
116116
* Criteria for selecting stacks to deploy
117117
*
118-
* @default - all stacks
118+
* @default - All stacks
119119
*/
120120
readonly stacks?: StackSelector;
121121

@@ -177,7 +177,7 @@ export interface BaseDeployOptions {
177177
* Whether to send logs from all CloudWatch log groups in the template
178178
* to the IoHost
179179
*
180-
* @default - false
180+
* @default false
181181
*/
182182
readonly traceLogs?: boolean;
183183
}

‎packages/@aws-cdk/toolkit-lib/lib/actions/deploy/private/deploy-options.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ export interface PrivateDeployOptions extends DeployOptions {
1212
/**
1313
* The extra string to append to the User-Agent header when performing AWS SDK calls.
1414
*
15-
* @default - nothing extra is appended to the User-Agent header
15+
* @default - Nothing extra is appended to the User-Agent header
1616
*/
1717
readonly extraUserAgent?: string;
1818

1919
/**
2020
* Allows adding CloudWatch log groups to the log monitor via
2121
* cloudWatchLogMonitor.setLogGroups();
2222
*
23-
* @default - not monitoring CloudWatch logs
23+
* @default - Not monitoring CloudWatch logs
2424
*/
2525
readonly cloudWatchLogMonitor?: CloudWatchLogEventMonitor;
2626
}

‎packages/@aws-cdk/toolkit-lib/lib/actions/destroy/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ export interface DestroyOptions {
44
/**
55
* Criteria for selecting stacks to deploy
66
*
7-
* @default - all stacks
7+
* @default - All stacks
88
*/
99
readonly stacks?: StackSelector;
1010

‎packages/@aws-cdk/toolkit-lib/lib/actions/diff/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export interface ChangeSetDiffOptions extends CloudFormationDiffOptions {
2323
/**
2424
* Additional parameters for CloudFormation when creating a diff change set
2525
*
26-
* @default - no parameters
26+
* @default - No parameters
2727
*/
2828
readonly parameters?: { [name: string]: string | undefined };
2929

@@ -95,7 +95,7 @@ export interface DiffOptions {
9595
/**
9696
* Select the stacks
9797
*
98-
* @default - all stacks
98+
* @default - All stacks
9999
*/
100100
readonly stacks?: StackSelector;
101101

‎packages/@aws-cdk/toolkit-lib/lib/actions/drift/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ export interface DriftOptions {
44
/**
55
* Select stacks to check for drift
66
*
7-
* @default - all stacks
7+
* @default - All stacks
88
*/
99
readonly stacks?: StackSelector;
1010
}

‎packages/@aws-cdk/toolkit-lib/lib/actions/refactor/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ export interface RefactorOptions {
7373
/**
7474
* Criteria for selecting stacks to deploy
7575
*
76-
* @default - all stacks
76+
* @default - All stacks
7777
*/
7878
stacks?: StackSelector;
7979

‎packages/@aws-cdk/toolkit-lib/lib/actions/rollback/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ export interface RollbackOptions {
44
/**
55
* Criteria for selecting stacks to rollback
66
*
7-
* @default - all stacks
7+
* @default - All stacks
88
*/
99
readonly stacks?: StackSelector;
1010

‎packages/@aws-cdk/toolkit-lib/lib/actions/watch/index.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ export interface WatchOptions extends BaseDeployOptions {
44
/**
55
* Watch the files in this list
66
*
7-
* @default - all files in the watchDir
7+
* @default - All files in the watchDir
88
*/
99
readonly include?: string[];
1010

@@ -14,14 +14,14 @@ export interface WatchOptions extends BaseDeployOptions {
1414
* Hidden files (those whose names begin with a dot `.`) are always excluded,
1515
* irrespectively of this option.
1616
*
17-
* @default - default patterns excluding likely irrelevant files for all CDK supported programming languages, this list will change over time
17+
* @default - Default patterns excluding likely irrelevant files for all CDK supported programming languages, this list will change over time
1818
*/
1919
readonly exclude?: string[];
2020

2121
/**
2222
* The root directory used for watch.
2323
*
24-
* @default - the current working directory
24+
* @default - Current working directory
2525
*/
2626
readonly watchDir?: string;
2727

‎packages/@aws-cdk/toolkit-lib/lib/api/aws-auth/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export interface SdkHttpOptions {
2727
*
2828
* Use this so set up a proxy connection.
2929
*
30-
* @default - uses the shared global node agent
30+
* @default - Uses the shared global node agent
3131
*/
3232
readonly agent?: https.Agent;
3333
}

‎packages/@aws-cdk/toolkit-lib/lib/api/bootstrap/bootstrap-props.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export interface BootstrapEnvironmentOptions {
2626
/**
2727
* The source of the bootstrap stack
2828
*
29-
* @default - modern v2-style bootstrapping
29+
* @default - Modern v2-style bootstrapping
3030
*/
3131
readonly source?: BootstrapSource;
3232

@@ -39,7 +39,7 @@ export interface BootstrapEnvironmentOptions {
3939
/**
4040
* Tags for cdktoolkit stack.
4141
*
42-
* @default - None.
42+
* @default - No value, optional argument
4343
*/
4444
readonly tags?: Tag[];
4545

@@ -67,14 +67,14 @@ export interface BootstrappingParameters {
6767
/**
6868
* The name to be given to the CDK Bootstrap bucket.
6969
*
70-
* @default - a name is generated by CloudFormation.
70+
* @default - A name is generated by CloudFormation
7171
*/
7272
readonly bucketName?: string;
7373

7474
/**
7575
* The ID of an existing KMS key to be used for encrypting items in the bucket.
7676
*
77-
* @default - use the default KMS key or create a custom one
77+
* @default - Use the default KMS key or create a custom one
7878
*/
7979
readonly kmsKeyId?: string;
8080

@@ -91,22 +91,22 @@ export interface BootstrappingParameters {
9191
/**
9292
* The list of AWS account IDs that are trusted to deploy into the environment being bootstrapped.
9393
*
94-
* @default - only the bootstrapped account can deploy into this environment
94+
* @default - Only the bootstrapped account can deploy into this environment
9595
*/
9696
readonly trustedAccounts?: string[];
9797

9898
/**
9999
* The list of AWS account IDs that are trusted to look up values in the environment being bootstrapped.
100100
*
101-
* @default - only the bootstrapped account can look up values in this environment
101+
* @default - Only the bootstrapped account can look up values in this environment
102102
*/
103103
readonly trustedAccountsForLookup?: string[];
104104

105105
/**
106106
* The list of AWS account IDs that should not be trusted by the bootstrapped environment.
107107
* If these accounts are already trusted, they will be removed on bootstrapping.
108108
*
109-
* @default - no account will be untrusted.
109+
* @default - No account will be untrusted
110110
*/
111111
readonly untrustedAccounts?: string[];
112112

@@ -115,7 +115,7 @@ export interface BootstrappingParameters {
115115
* In most cases, this will be the AdministratorAccess policy.
116116
* At least one policy is required if `trustedAccounts` were passed.
117117
*
118-
* @default - the role will have no policies attached
118+
* @default - The role will have no policies attached
119119
*/
120120
readonly cloudFormationExecutionPolicies?: string[];
121121

‎packages/@aws-cdk/toolkit-lib/lib/api/cloud-assembly/source-builder.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ export interface AssemblySourceProps {
8989
* The context store will be used to source initial context values,
9090
* and updated values will be stored here.
9191
*
92-
* @default - depend on the operation
92+
* @default - Depends on the operation
9393
*/
9494
readonly contextStore?: IContextStore;
9595

@@ -164,7 +164,7 @@ export interface FromCdkAppOptions extends AssemblySourceProps {
164164
/**
165165
* Execute the application in this working directory.
166166
*
167-
* @default - current working directory
167+
* @default - Current working directory
168168
*/
169169
readonly workingDirectory?: string;
170170

‎packages/@aws-cdk/toolkit-lib/lib/api/deployments/deploy-stack.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ export interface DeployStackOptions {
8686
* string though `TargetEnvironment.replacePlaceholders`.
8787
*
8888
* @default - No execution role; CloudFormation either uses the role currently associated with
89-
* the stack, or otherwise uses current AWS credentials.
89+
* the stack, or otherwise uses current AWS credentials
9090
*/
9191
readonly roleArn?: StringWithoutPlaceholders;
9292

@@ -132,7 +132,7 @@ export interface DeployStackOptions {
132132
* Note that parameters with `undefined` or empty values will be ignored,
133133
* and not passed to the template.
134134
*
135-
* @default - no additional parameters will be passed to the template
135+
* @default - No additional parameters will be passed to the template
136136
*/
137137
readonly parameters?: { [name: string]: string | undefined };
138138

@@ -179,7 +179,7 @@ export interface DeployStackOptions {
179179
/**
180180
* The extra string to append to the User-Agent header when performing AWS SDK calls.
181181
*
182-
* @default - nothing extra is appended to the User-Agent header
182+
* @default - Nothing extra is appended to the User-Agent header
183183
*/
184184
readonly extraUserAgent?: string;
185185

‎packages/@aws-cdk/toolkit-lib/lib/api/deployments/deployments.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ export interface DeployStackOptions {
8888
/**
8989
* Stage the change set but don't execute it
9090
*
91-
* @default - true
91+
* @default true
9292
* @deprecated Use 'deploymentMethod' instead
9393
*/
9494
readonly execute?: boolean;
@@ -116,7 +116,7 @@ export interface DeployStackOptions {
116116

117117
/**
118118
* Extra parameters for CloudFormation
119-
* @default - no additional parameters will be passed to the template
119+
* @default - No additional parameters will be passed to the template
120120
*/
121121
readonly parameters?: { [name: string]: string | undefined };
122122

@@ -157,7 +157,7 @@ export interface DeployStackOptions {
157157
/**
158158
* The extra string to append to the User-Agent header when performing AWS SDK calls.
159159
*
160-
* @default - nothing extra is appended to the User-Agent header
160+
* @default - Nothing extra is appended to the User-Agent header
161161
*/
162162
readonly extraUserAgent?: string;
163163

‎packages/@aws-cdk/toolkit-lib/lib/api/logs-monitor/logs-monitor.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export interface CloudWatchLogEventMonitorProps {
3636
/**
3737
* The time from which we start reading log messages
3838
*
39-
* @default - now
39+
* @default - Now
4040
*/
4141
readonly startTime?: Date;
4242
}

‎packages/@aws-cdk/toolkit-lib/lib/api/notices/filter.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ interface ActualComponent {
3535
* If there is more than one component with the same dynamic name, they are
3636
* joined by ','.
3737
*
38-
* @default - Don't add to the set of dynamic values.
38+
* @default - Don't add to the set of dynamic values
3939
*/
4040
readonly dynamicName?: string;
4141

@@ -45,7 +45,7 @@ interface ActualComponent {
4545
* Only used if `dynamicName` is set; by default we will add the actual version
4646
* of the component.
4747
*
48-
* @default - The version.
48+
* @default - The version
4949
*/
5050
readonly dynamicValue?: string;
5151
}

‎packages/@aws-cdk/toolkit-lib/lib/api/notices/notices.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface NoticesHttpOptions {
2222
*
2323
* Use this so set up a proxy connection.
2424
*
25-
* @default - uses the shared global node agent
25+
* @default - Uses the shared global node agent
2626
*/
2727
readonly agent?: Agent;
2828
}

‎packages/@aws-cdk/toolkit-lib/lib/api/notices/web-data-source.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ export class WebsiteNoticeDataSourceProps {
1717
*
1818
* @see https://github.com/cdklabs/aws-cdk-notices
1919
*
20-
* @default - official CDK notices
20+
* @default - Official CDK notices
2121
*/
2222
readonly url?: string | URL;
2323
/**
2424
* The agent responsible for making the network requests.
2525
*
2626
* Use this so set up a proxy connection.
2727
*
28-
* @default - uses the shared global node agent
28+
* @default - Uses the shared global node agent
2929
*/
3030
readonly agent?: https.Agent;
3131
}

‎packages/@aws-cdk/toolkit-lib/lib/api/stack-events/stack-activity-monitor.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export interface StackActivityMonitorProps {
3535
*
3636
* Used to calculate a progress bar.
3737
*
38-
* @default - No progress reporting.
38+
* @default - No progress reporting
3939
*/
4040
readonly resourcesTotal?: number;
4141

@@ -48,7 +48,7 @@ export interface StackActivityMonitorProps {
4848
* It is recommended to use this, otherwise the filtering will be subject
4949
* to clock drift between local and cloud machines.
5050
*
51-
* @default - local machine's current time
51+
* @default - Local machine's current time
5252
*/
5353
readonly changeSetCreationTime?: Date;
5454

‎packages/@aws-cdk/toolkit-lib/lib/payloads/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ export interface ConfirmationRequest {
106106
* If more than one operations is on-going, a client might decide that asking the user
107107
* for input is too complex, as the confirmation might not easily be attributed to a specific request.
108108
*
109-
* @default - no concurrency
109+
* @default - No concurrency
110110
*/
111111
readonly concurrency?: number;
112112
}

‎packages/@aws-cdk/toolkit-lib/lib/toolkit/non-interactive-io-host.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export interface NonInteractiveIoHostProps {
2020
*
2121
* When TTY is disabled, the CLI will have no interactions or color.
2222
*
23-
* @default - determined from the current process
23+
* @default - Determined from the current process
2424
*/
2525
readonly isTTY?: boolean;
2626

@@ -30,7 +30,7 @@ export interface NonInteractiveIoHostProps {
3030
* In CI mode, all non-error output goes to stdout instead of stderr.
3131
* Set to false in the IoHost constructor it will be overwritten if the CLI CI argument is passed
3232
*
33-
* @default - determined from the environment, specifically based on `process.env.CI`
33+
* @default - Determined from the environment, specifically based on `process.env.CI`
3434
*/
3535
readonly isCI?: boolean;
3636
}

0 commit comments

Comments
 (0)