Make it clearer what is an optional input for the generator.

amzn · Apr 27, 2021 · afa6e5a · afa6e5a
1 parent 634fd06
commit afa6e5a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -31,7 +31,7 @@ matrix:
       dist: xenial
       sudo: required
       services: docker
-      env: DOCKER_IMAGE_TAG=swift:5.2.5-bionic ONLY_RUN_SWIFT_LINT=no USE_APT_GET=yes
+      env: DOCKER_IMAGE_TAG=swift:5.2.4-bionic ONLY_RUN_SWIFT_LINT=no USE_APT_GET=yes
 
     - os: linux
       dist: xenial

diff --git a/README.md b/README.md
@@ -137,7 +137,7 @@ import SmokeAWSCredentials
         return Log.error("Unable to obtain credentials from the container environment.")
     }
 
-    // for the EC2 clients, only emit the retry count metric
+    // optional: for the EC2 clients, only emit the retry count metric
     // only report 5XX error counts for DescribeInstances (even if additional operations are added in the future)
     // only report 4XX error counts for operations other than DescribeInstances (including if they are added in the future)
     let reportingConfiguration = SmokeAWSClientReportingConfiguration<ElasticComputeCloudModelOperations>(
@@ -151,10 +151,10 @@ import SmokeAWSCredentials
         credentialsProvider: credentialsProvider,
         awsRegion: region,
         endpointHostName: ec2EndpointHostName,
-        connectionTimeoutSeconds: connectionTimeoutSeconds,
-        retryConfiguration: retryConfiguration,
-        eventLoopProvider: .createNew,
-        reportingConfiguration: reportingConfiguration)
+        connectionTimeoutSeconds: connectionTimeoutSeconds, // optional
+        retryConfiguration: retryConfiguration,             // optional
+        eventLoopProvider: .createNew,                      // optional
+        reportingConfiguration: reportingConfiguration)     // optional
 ```
 
 The inputs to this constructor are-