update jsdoc comments

glennschler · Nov 8, 2015 · ab57c3c · ab57c3c
1 parent 8533ae1
commit ab57c3c
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git a/lib/service.js b/lib/service.js
@@ -146,9 +146,9 @@ internals.Credentials.prototype._update = function (options) {
  * @arg {string} options.keys.region - The EC2 region to send service requests
  * @arg {object} options.upgrade - Temporary Session Token credentials. See [aws docs]{@link http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#getSessionToken-property}
  * @arg {string} options.upgrade.serialNumber - Identifies the user's hardware or virtual MFA device
- * @arg {string} options.upgrade.tokenCode - Time-based one-time password (TOTP) that the MFA devices produces
- * @arg {string} [options.upgrade.durationSeconds=900] - The duration, in seconds, that the credentials should remain valid
- * @arg {boolean} [options.isLogging] - Use internal logging
+ * @arg {number} options.upgrade.tokenCode - Time-based one-time password (TOTP) that the MFA devices produces
+ * @arg {number} [options.upgrade.durationSeconds=900] - The duration, in seconds, that the credentials should remain valid
+ * @arg {boolean} [options.isLogging=false] - Use internal logging
  * @throws {error}
  * @emits {AwsSvc#complete}
  */

diff --git a/lib/spotspec.js b/lib/spotspec.js
@@ -26,8 +26,8 @@ let internals = {
 * @arg {object} options.upgrade - Temporary Session Token credentials - See [aws docs]{@link http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#getSessionToken-property}
 * @arg {string} options.upgrade.serialNumber - Identifies the user's hardware or virtual MFA device.
 * @arg {string} options.upgrade.tokenCode - Time-based one-time password (TOTP) that the MFA devices produces
-* @arg {number} options.upgrade.durationSeconds - How long the temporary key will last
-* @arg {boolean} - options.isLogging
+* @arg {number} [options.upgrade.durationSeconds=900] - How long the temporary key will last
+* @arg {boolean} [options.isLogging=false] - Use internal logging
 * @throws {error}
 * @emits {SpotSpec#initialized}
 */
@@ -62,7 +62,7 @@ Util.inherits(SpotSpec, AwsSvc)
 * @arg {object} options - JSON options to request current price
 * @arg {string} options.type - The instance type to be priced e.g. m3.medium
 * @arg {string} [options.product=Linux/UNIX] - e.g. 'Windows'
-* @arg {boolean} [options.dryRun=true] - Only verify parameters.
+* @arg {boolean} [options.dryRun=false] - Only verify parameters.
 * @arg {boolean} [options.isLogging=false]
 * @emits SpotSpec#priced
 */
@@ -122,7 +122,7 @@ SpotSpec.prototype.prices = function (options) {
 * @arg {string} options.type - The amazon Instance Type e.g. m3.medium
 * @arg {string} options.price - The maximum price limit
 * @arg {string} options.keyName - The name of the key pair needed to access the launched instance. See [user guide]{@link http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html}
-* @arg {boolean} [options.dryRun=true] - Only verify launch parameters. if TRUE, do not launch an instance
+* @arg {boolean} [options.dryRun=false] - Only verify launch parameters. if TRUE, do not launch an instance
 * @arg {number} [options.count=1] - The InstanceCount number to launch
 * @arg {string[]} [options.securityGroupIds] - Array of one or more security group ids. See [user guide]{@link http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html}
 * @arg {string[]} [options.securityGroups] - Array of one or more security group names. See [user guide]{@link http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html}
@@ -186,7 +186,7 @@ SpotSpec.prototype.launch = function launch (options) {
 /**
 * describeRequests - Describe the status of all current spot requests See [aws docs]{@link http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/EC2.html#describeSpotInstanceRequests-property}
 * @arg {object} options - JSON options to request current price
-* @arg {boolean} [options.dryRun=true] - Only verify parameters.
+* @arg {boolean} [options.dryRun=false] - Only verify parameters.
 * @emits SpotSpec#priced
 */
 SpotSpec.prototype.describeRequests = function spotDescribe () {
@@ -224,7 +224,7 @@ SpotSpec.prototype.describeRequests = function spotDescribe () {
 /**
 * Describe the status of all running instance.
 * @arg {object} options - JSON options to request current price
-* @arg {boolean} [options.dryRun=true] - Only verify parameters.
+* @arg {boolean} [options.dryRun=false] - Only verify parameters.
 * @emits {SpotSpec#Reservations[]} Array of EC2 instances
 */
 SpotSpec.prototype.describeInstances = function describeInstances (options) {