chore(toolkit-lib): formatting and grammar changes in TSDoc comments (#582)

iankhou · github-actions · web-flow · commit d981af18b5f5 · 2025-06-06T20:51:49.000Z
- 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 &lt;github-actions@github.com&gt;
Co-authored-by: github-actions &lt;github-actions@github.com&gt;
diff --git a/packages/@aws-cdk/toolkit-lib/lib/actions/bootstrap/index.ts b/packages/@aws-cdk/toolkit-lib/lib/actions/bootstrap/index.ts
@@ -152,7 +152,7 @@ export interface BootstrapParameters {
    * Identifier to distinguish multiple bootstrapped environments
    * The default qualifier is an arbitrary but unique string
    *
-   * @default - 'hnb659fds'
+   * @default 'hnb659fds'
    */
   readonly qualifier?: string;
 
diff --git a/packages/@aws-cdk/toolkit-lib/lib/actions/deploy/index.ts b/packages/@aws-cdk/toolkit-lib/lib/actions/deploy/index.ts
@@ -50,14 +50,14 @@ export interface HotswapDeployment {
    * Represents configuration property overrides for hotswap deployments.
    * Currently only supported by ECS.
    *
-   * @default - no overrides
+   * @default - No overrides
    */
   readonly properties?: HotswapProperties;
 
   /**
    * Fall back to a CloudFormation deployment when a non-hotswappable change is detected
    *
-   * @default - do not fall back to a CloudFormation deployment
+   * @default - Do not fall back to a CloudFormation deployment
    */
   readonly fallback?: DirectDeployment | ChangeSetDeployment;
 }
@@ -115,7 +115,7 @@ export interface BaseDeployOptions {
   /**
    * Criteria for selecting stacks to deploy
    *
-   * @default - all stacks
+   * @default - All stacks
    */
   readonly stacks?: StackSelector;
 
@@ -177,7 +177,7 @@ export interface BaseDeployOptions {
    * Whether to send logs from all CloudWatch log groups in the template
    * to the IoHost
    *
-   * @default - false
+   * @default false
    */
   readonly traceLogs?: boolean;
 }
diff --git a/packages/@aws-cdk/toolkit-lib/lib/actions/deploy/private/deploy-options.ts b/packages/@aws-cdk/toolkit-lib/lib/actions/deploy/private/deploy-options.ts
@@ -12,15 +12,15 @@ export interface PrivateDeployOptions extends DeployOptions {
   /**
    * The extra string to append to the User-Agent header when performing AWS SDK calls.
    *
-   * @default - nothing extra is appended to the User-Agent header
+   * @default - Nothing extra is appended to the User-Agent header
    */
   readonly extraUserAgent?: string;
 
   /**
    * Allows adding CloudWatch log groups to the log monitor via
    * cloudWatchLogMonitor.setLogGroups();
    *
-   * @default - not monitoring CloudWatch logs
+   * @default - Not monitoring CloudWatch logs
    */
   readonly cloudWatchLogMonitor?: CloudWatchLogEventMonitor;
 }
diff --git a/packages/@aws-cdk/toolkit-lib/lib/actions/destroy/index.ts b/packages/@aws-cdk/toolkit-lib/lib/actions/destroy/index.ts
@@ -4,7 +4,7 @@ export interface DestroyOptions {
   /**
    * Criteria for selecting stacks to deploy
    *
-   * @default - all stacks
+   * @default - All stacks
    */
   readonly stacks?: StackSelector;
 
diff --git a/packages/@aws-cdk/toolkit-lib/lib/actions/diff/index.ts b/packages/@aws-cdk/toolkit-lib/lib/actions/diff/index.ts
@@ -23,7 +23,7 @@ export interface ChangeSetDiffOptions extends CloudFormationDiffOptions {
   /**
    * Additional parameters for CloudFormation when creating a diff change set
    *
-   * @default - no parameters
+   * @default - No parameters
    */
   readonly parameters?: { [name: string]: string | undefined };
 
@@ -95,7 +95,7 @@ export interface DiffOptions {
   /**
    * Select the stacks
    *
-   * @default - all stacks
+   * @default - All stacks
    */
   readonly stacks?: StackSelector;
 
diff --git a/packages/@aws-cdk/toolkit-lib/lib/actions/drift/index.ts b/packages/@aws-cdk/toolkit-lib/lib/actions/drift/index.ts
@@ -4,7 +4,7 @@ export interface DriftOptions {
   /**
    * Select stacks to check for drift
    *
-   * @default - all stacks
+   * @default - All stacks
    */
   readonly stacks?: StackSelector;
 }
diff --git a/packages/@aws-cdk/toolkit-lib/lib/actions/refactor/index.ts b/packages/@aws-cdk/toolkit-lib/lib/actions/refactor/index.ts
@@ -73,7 +73,7 @@ export interface RefactorOptions {
   /**
    * Criteria for selecting stacks to deploy
    *
-   * @default - all stacks
+   * @default - All stacks
    */
   stacks?: StackSelector;
 
diff --git a/packages/@aws-cdk/toolkit-lib/lib/actions/rollback/index.ts b/packages/@aws-cdk/toolkit-lib/lib/actions/rollback/index.ts
@@ -4,7 +4,7 @@ export interface RollbackOptions {
   /**
    * Criteria for selecting stacks to rollback
    *
-   * @default - all stacks
+   * @default - All stacks
    */
   readonly stacks?: StackSelector;
 
diff --git a/packages/@aws-cdk/toolkit-lib/lib/actions/watch/index.ts b/packages/@aws-cdk/toolkit-lib/lib/actions/watch/index.ts
@@ -4,7 +4,7 @@ export interface WatchOptions extends BaseDeployOptions {
   /**
    * Watch the files in this list
    *
-   * @default - all files in the watchDir
+   * @default - All files in the watchDir
    */
   readonly include?: string[];
 
@@ -14,14 +14,14 @@ export interface WatchOptions extends BaseDeployOptions {
    * Hidden files (those whose names begin with a dot `.`) are always excluded,
    * irrespectively of this option.
    *
-   * @default - default patterns excluding likely irrelevant files for all CDK supported programming languages, this list will change over time
+   * @default - Default patterns excluding likely irrelevant files for all CDK supported programming languages, this list will change over time
    */
   readonly exclude?: string[];
 
   /**
    * The root directory used for watch.
    *
-   * @default - the current working directory
+   * @default - Current working directory
    */
   readonly watchDir?: string;
 
diff --git a/packages/@aws-cdk/toolkit-lib/lib/api/aws-auth/types.ts b/packages/@aws-cdk/toolkit-lib/lib/api/aws-auth/types.ts
@@ -27,7 +27,7 @@ export interface SdkHttpOptions {
    *
    * Use this so set up a proxy connection.
    *
-   * @default - uses the shared global node agent
+   * @default - Uses the shared global node agent
    */
   readonly agent?: https.Agent;
 }
diff --git a/packages/@aws-cdk/toolkit-lib/lib/api/bootstrap/bootstrap-props.ts b/packages/@aws-cdk/toolkit-lib/lib/api/bootstrap/bootstrap-props.ts
@@ -26,7 +26,7 @@ export interface BootstrapEnvironmentOptions {
   /**
    * The source of the bootstrap stack
    *
-   * @default - modern v2-style bootstrapping
+   * @default - Modern v2-style bootstrapping
    */
   readonly source?: BootstrapSource;
 
@@ -39,7 +39,7 @@ export interface BootstrapEnvironmentOptions {
   /**
    * Tags for cdktoolkit stack.
    *
-   * @default - None.
+   * @default - No value, optional argument
    */
   readonly tags?: Tag[];
 
@@ -67,14 +67,14 @@ export interface BootstrappingParameters {
   /**
    * The name to be given to the CDK Bootstrap bucket.
    *
-   * @default - a name is generated by CloudFormation.
+   * @default - A name is generated by CloudFormation
    */
   readonly bucketName?: string;
 
   /**
    * The ID of an existing KMS key to be used for encrypting items in the bucket.
    *
-   * @default - use the default KMS key or create a custom one
+   * @default - Use the default KMS key or create a custom one
    */
   readonly kmsKeyId?: string;
 
@@ -91,22 +91,22 @@ export interface BootstrappingParameters {
   /**
    * The list of AWS account IDs that are trusted to deploy into the environment being bootstrapped.
    *
-   * @default - only the bootstrapped account can deploy into this environment
+   * @default - Only the bootstrapped account can deploy into this environment
    */
   readonly trustedAccounts?: string[];
 
   /**
    * The list of AWS account IDs that are trusted to look up values in the environment being bootstrapped.
    *
-   * @default - only the bootstrapped account can look up values in this environment
+   * @default - Only the bootstrapped account can look up values in this environment
    */
   readonly trustedAccountsForLookup?: string[];
 
   /**
    * The list of AWS account IDs that should not be trusted by the bootstrapped environment.
    * If these accounts are already trusted, they will be removed on bootstrapping.
    *
-   * @default - no account will be untrusted.
+   * @default - No account will be untrusted
    */
   readonly untrustedAccounts?: string[];
 
@@ -115,7 +115,7 @@ export interface BootstrappingParameters {
    * In most cases, this will be the AdministratorAccess policy.
    * At least one policy is required if `trustedAccounts` were passed.
    *
-   * @default - the role will have no policies attached
+   * @default - The role will have no policies attached
    */
   readonly cloudFormationExecutionPolicies?: string[];
 
diff --git a/packages/@aws-cdk/toolkit-lib/lib/api/cloud-assembly/source-builder.ts b/packages/@aws-cdk/toolkit-lib/lib/api/cloud-assembly/source-builder.ts
@@ -89,7 +89,7 @@ export interface AssemblySourceProps {
    * The context store will be used to source initial context values,
    * and updated values will be stored here.
    *
-   * @default - depend on the operation
+   * @default - Depends on the operation
    */
   readonly contextStore?: IContextStore;
 
@@ -164,7 +164,7 @@ export interface FromCdkAppOptions extends AssemblySourceProps {
   /**
    * Execute the application in this working directory.
    *
-   * @default - current working directory
+   * @default - Current working directory
    */
   readonly workingDirectory?: string;
 
diff --git a/packages/@aws-cdk/toolkit-lib/lib/api/deployments/deploy-stack.ts b/packages/@aws-cdk/toolkit-lib/lib/api/deployments/deploy-stack.ts
@@ -86,7 +86,7 @@ export interface DeployStackOptions {
    * string though `TargetEnvironment.replacePlaceholders`.
    *
    * @default - No execution role; CloudFormation either uses the role currently associated with
-   * the stack, or otherwise uses current AWS credentials.
+   * the stack, or otherwise uses current AWS credentials
    */
   readonly roleArn?: StringWithoutPlaceholders;
 
@@ -132,7 +132,7 @@ export interface DeployStackOptions {
    * Note that parameters with `undefined` or empty values will be ignored,
    * and not passed to the template.
    *
-   * @default - no additional parameters will be passed to the template
+   * @default - No additional parameters will be passed to the template
    */
   readonly parameters?: { [name: string]: string | undefined };
 
@@ -179,7 +179,7 @@ export interface DeployStackOptions {
   /**
    * The extra string to append to the User-Agent header when performing AWS SDK calls.
    *
-   * @default - nothing extra is appended to the User-Agent header
+   * @default - Nothing extra is appended to the User-Agent header
    */
   readonly extraUserAgent?: string;
 
diff --git a/packages/@aws-cdk/toolkit-lib/lib/api/deployments/deployments.ts b/packages/@aws-cdk/toolkit-lib/lib/api/deployments/deployments.ts
@@ -88,7 +88,7 @@ export interface DeployStackOptions {
   /**
    * Stage the change set but don't execute it
    *
-   * @default - true
+   * @default true
    * @deprecated Use 'deploymentMethod' instead
    */
   readonly execute?: boolean;
@@ -116,7 +116,7 @@ export interface DeployStackOptions {
 
   /**
    * Extra parameters for CloudFormation
-   * @default - no additional parameters will be passed to the template
+   * @default - No additional parameters will be passed to the template
    */
   readonly parameters?: { [name: string]: string | undefined };
 
@@ -157,7 +157,7 @@ export interface DeployStackOptions {
   /**
    * The extra string to append to the User-Agent header when performing AWS SDK calls.
    *
-   * @default - nothing extra is appended to the User-Agent header
+   * @default - Nothing extra is appended to the User-Agent header
    */
   readonly extraUserAgent?: string;
 
diff --git a/packages/@aws-cdk/toolkit-lib/lib/api/logs-monitor/logs-monitor.ts b/packages/@aws-cdk/toolkit-lib/lib/api/logs-monitor/logs-monitor.ts
@@ -36,7 +36,7 @@ export interface CloudWatchLogEventMonitorProps {
   /**
    * The time from which we start reading log messages
    *
-   * @default - now
+   * @default - Now
    */
   readonly startTime?: Date;
 }
diff --git a/packages/@aws-cdk/toolkit-lib/lib/api/notices/filter.ts b/packages/@aws-cdk/toolkit-lib/lib/api/notices/filter.ts
@@ -35,7 +35,7 @@ interface ActualComponent {
    * If there is more than one component with the same dynamic name, they are
    * joined by ','.
    *
-   * @default - Don't add to the set of dynamic values.
+   * @default - Don't add to the set of dynamic values
    */
   readonly dynamicName?: string;
 
@@ -45,7 +45,7 @@ interface ActualComponent {
    * Only used if `dynamicName` is set; by default we will add the actual version
    * of the component.
    *
-   * @default - The version.
+   * @default - The version
    */
   readonly dynamicValue?: string;
 }
diff --git a/packages/@aws-cdk/toolkit-lib/lib/api/notices/notices.ts b/packages/@aws-cdk/toolkit-lib/lib/api/notices/notices.ts
@@ -22,7 +22,7 @@ export interface NoticesHttpOptions {
    *
    * Use this so set up a proxy connection.
    *
-   * @default - uses the shared global node agent
+   * @default - Uses the shared global node agent
    */
   readonly agent?: Agent;
 }
diff --git a/packages/@aws-cdk/toolkit-lib/lib/api/notices/web-data-source.ts b/packages/@aws-cdk/toolkit-lib/lib/api/notices/web-data-source.ts
@@ -17,15 +17,15 @@ export class WebsiteNoticeDataSourceProps {
    *
    * @see https://github.com/cdklabs/aws-cdk-notices
    *
-   * @default - official CDK notices
+   * @default - Official CDK notices
    */
   readonly url?: string | URL;
   /**
    * The agent responsible for making the network requests.
    *
    * Use this so set up a proxy connection.
    *
-   * @default - uses the shared global node agent
+   * @default - Uses the shared global node agent
    */
   readonly agent?: https.Agent;
 }
diff --git a/packages/@aws-cdk/toolkit-lib/lib/api/stack-events/stack-activity-monitor.ts b/packages/@aws-cdk/toolkit-lib/lib/api/stack-events/stack-activity-monitor.ts
@@ -35,7 +35,7 @@ export interface StackActivityMonitorProps {
    *
    * Used to calculate a progress bar.
    *
-   * @default - No progress reporting.
+   * @default - No progress reporting
    */
   readonly resourcesTotal?: number;
 
@@ -48,7 +48,7 @@ export interface StackActivityMonitorProps {
    * It is recommended to use this, otherwise the filtering will be subject
    * to clock drift between local and cloud machines.
    *
-   * @default - local machine's current time
+   * @default - Local machine's current time
    */
   readonly changeSetCreationTime?: Date;
 
diff --git a/packages/@aws-cdk/toolkit-lib/lib/payloads/types.ts b/packages/@aws-cdk/toolkit-lib/lib/payloads/types.ts
@@ -106,7 +106,7 @@ export interface ConfirmationRequest {
    * If more than one operations is on-going, a client might decide that asking the user
    * for input is too complex, as the confirmation might not easily be attributed to a specific request.
    *
-   * @default - no concurrency
+   * @default - No concurrency
    */
   readonly concurrency?: number;
 }
diff --git a/packages/@aws-cdk/toolkit-lib/lib/toolkit/non-interactive-io-host.ts b/packages/@aws-cdk/toolkit-lib/lib/toolkit/non-interactive-io-host.ts
@@ -20,7 +20,7 @@ export interface NonInteractiveIoHostProps {
    *
    * When TTY is disabled, the CLI will have no interactions or color.
    *
-   * @default - determined from the current process
+   * @default - Determined from the current process
    */
   readonly isTTY?: boolean;
 
@@ -30,7 +30,7 @@ export interface NonInteractiveIoHostProps {
    * In CI mode, all non-error output goes to stdout instead of stderr.
    * Set to false in the IoHost constructor it will be overwritten if the CLI CI argument is passed
    *
-   * @default - determined from the environment, specifically based on `process.env.CI`
+   * @default - Determined from the environment, specifically based on `process.env.CI`
    */
   readonly isCI?: boolean;
 }
diff --git a/packages/@aws-cdk/toolkit-lib/lib/toolkit/toolkit.ts b/packages/@aws-cdk/toolkit-lib/lib/toolkit/toolkit.ts

Original file line number	Diff line number	Diff line change
`@@ -152,7 +152,7 @@ export interface BootstrapParameters {`
`152`	`152`	`* Identifier to distinguish multiple bootstrapped environments`
`153`	`153`	`* The default qualifier is an arbitrary but unique string`
`154`	`154`	`*`
`155`		`- * @default - 'hnb659fds'`
	`155`	`+ * @default 'hnb659fds'`
`156`	`156`	`*/`
`157`	`157`	`readonly qualifier?: string;`
`158`	`158`
Original file line number	Diff line number	Diff line change
`@@ -50,14 +50,14 @@ export interface HotswapDeployment {`
`50`	`50`	`* Represents configuration property overrides for hotswap deployments.`
`51`	`51`	`* Currently only supported by ECS.`
`52`	`52`	`*`
`53`		`- * @default - no overrides`
	`53`	`+ * @default - No overrides`
`54`	`54`	`*/`
`55`	`55`	`readonly properties?: HotswapProperties;`
`56`	`56`
`57`	`57`	`/**`
`58`	`58`	`* Fall back to a CloudFormation deployment when a non-hotswappable change is detected`
`59`	`59`	`*`
`60`		`- * @default - do not fall back to a CloudFormation deployment`
	`60`	`+ * @default - Do not fall back to a CloudFormation deployment`
`61`	`61`	`*/`
`62`	`62`	`readonly fallback?: DirectDeployment \| ChangeSetDeployment;`
`63`	`63`	`}`
`@@ -115,7 +115,7 @@ export interface BaseDeployOptions {`
`115`	`115`	`/**`
`116`	`116`	`* Criteria for selecting stacks to deploy`
`117`	`117`	`*`
`118`		`- * @default - all stacks`
	`118`	`+ * @default - All stacks`
`119`	`119`	`*/`
`120`	`120`	`readonly stacks?: StackSelector;`
`121`	`121`
`@@ -177,7 +177,7 @@ export interface BaseDeployOptions {`
`177`	`177`	`* Whether to send logs from all CloudWatch log groups in the template`
`178`	`178`	`* to the IoHost`
`179`	`179`	`*`
`180`		`- * @default - false`
	`180`	`+ * @default false`
`181`	`181`	`*/`
`182`	`182`	`readonly traceLogs?: boolean;`
`183`	`183`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,15 +12,15 @@ export interface PrivateDeployOptions extends DeployOptions {`
`12`	`12`	`/**`
`13`	`13`	`* The extra string to append to the User-Agent header when performing AWS SDK calls.`
`14`	`14`	`*`
`15`		`- * @default - nothing extra is appended to the User-Agent header`
	`15`	`+ * @default - Nothing extra is appended to the User-Agent header`
`16`	`16`	`*/`
`17`	`17`	`readonly extraUserAgent?: string;`
`18`	`18`
`19`	`19`	`/**`
`20`	`20`	`* Allows adding CloudWatch log groups to the log monitor via`
`21`	`21`	`* cloudWatchLogMonitor.setLogGroups();`
`22`	`22`	`*`
`23`		`- * @default - not monitoring CloudWatch logs`
	`23`	`+ * @default - Not monitoring CloudWatch logs`
`24`	`24`	`*/`
`25`	`25`	`readonly cloudWatchLogMonitor?: CloudWatchLogEventMonitor;`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ export interface DestroyOptions {`
`4`	`4`	`/**`
`5`	`5`	`* Criteria for selecting stacks to deploy`
`6`	`6`	`*`
`7`		`- * @default - all stacks`
	`7`	`+ * @default - All stacks`
`8`	`8`	`*/`
`9`	`9`	`readonly stacks?: StackSelector;`
`10`	`10`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ export interface DriftOptions {`
`4`	`4`	`/**`
`5`	`5`	`* Select stacks to check for drift`
`6`	`6`	`*`
`7`		`- * @default - all stacks`
	`7`	`+ * @default - All stacks`
`8`	`8`	`*/`
`9`	`9`	`readonly stacks?: StackSelector;`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ export interface RefactorOptions {`
`73`	`73`	`/**`
`74`	`74`	`* Criteria for selecting stacks to deploy`
`75`	`75`	`*`
`76`		`- * @default - all stacks`
	`76`	`+ * @default - All stacks`
`77`	`77`	`*/`
`78`	`78`	`stacks?: StackSelector;`
`79`	`79`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ export interface RollbackOptions {`
`4`	`4`	`/**`
`5`	`5`	`* Criteria for selecting stacks to rollback`
`6`	`6`	`*`
`7`		`- * @default - all stacks`
	`7`	`+ * @default - All stacks`
`8`	`8`	`*/`
`9`	`9`	`readonly stacks?: StackSelector;`
`10`	`10`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ export interface SdkHttpOptions {`
`27`	`27`	`*`
`28`	`28`	`* Use this so set up a proxy connection.`
`29`	`29`	`*`
`30`		`- * @default - uses the shared global node agent`
	`30`	`+ * @default - Uses the shared global node agent`
`31`	`31`	`*/`
`32`	`32`	`readonly agent?: https.Agent;`
`33`	`33`	`}`