chore: fixing linting violations where @default documentation is miss…

…ing (aws#2615)
zhiyouce · May 23, 2019 · f692c98 · f692c98
1 parent b9cbb6a
commit f692c98
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/design/aws-ecs-autoscaling-queue-worker.md b/design/aws-ecs-autoscaling-queue-worker.md
@@ -112,7 +112,7 @@ export interface Ec2QueueWorkerServiceProps {
   /**
    * The minimum number of CPU units to reserve for the container.
    *
-   * @default none
+   * @default - No minimum CPU units reserved.
    */
   readonly cpu?: number;
 
@@ -123,6 +123,8 @@ export interface Ec2QueueWorkerServiceProps {
    * is terminated.
    *
    * At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services.
+   *
+   * @default - No memory limit.
    */
   readonly memoryLimitMiB?: number;
 
@@ -135,6 +137,8 @@ export interface Ec2QueueWorkerServiceProps {
    * the available memory on the container instance—whichever comes first.
    *
    * At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services.
+   *
+   * @default - No memory reserved.
    */
   readonly memoryReservationMiB?: number;
 }

diff --git a/packages/@aws-cdk/aws-ecs/lib/ecs-queue-worker-service.ts b/packages/@aws-cdk/aws-ecs/lib/ecs-queue-worker-service.ts
@@ -10,7 +10,7 @@ export interface Ec2QueueWorkerServiceProps extends QueueWorkerServiceBaseProps
   /**
    * The minimum number of CPU units to reserve for the container.
    *
-   * @default none
+   * @default - No minimum CPU units reserved.
    */
   readonly cpu?: number;
 
@@ -21,6 +21,8 @@ export interface Ec2QueueWorkerServiceProps extends QueueWorkerServiceBaseProps
    * is terminated.
    *
    * At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services.
+   *
+   * @default - No memory limit.
    */
   readonly memoryLimitMiB?: number;
 
@@ -33,6 +35,8 @@ export interface Ec2QueueWorkerServiceProps extends QueueWorkerServiceBaseProps
    * the available memory on the container instance—whichever comes first.
    *
    * At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services.
+   *
+   * @default - No memory reserved.
    */
   readonly memoryReservationMiB?: number;
 }