Replacing '@param {Object} options' with '@param {Object} [options]' p…

…hetsims/chipper#859
phetsims · Feb 5, 2020 · dfccee1 · dfccee1
1 parent 91d423d
commit dfccee1
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/js/build-server/notifyServer.js b/js/build-server/notifyServer.js
@@ -10,7 +10,7 @@ const winston = require( 'winston' );
 /**
  * Notify the website that a new sim or translation has been deployed. This will cause the project to
  * synchronize and the new translation will appear on the website.
- * @param {Object} options
+ * @param {Object} [options]
  *  @property {string} simName
  *  @property {string} email
  *  @property {string} brand

diff --git a/js/common/SimVersion.js b/js/common/SimVersion.js
@@ -58,7 +58,7 @@ const assert = typeof module !== 'undefined' ? require( 'assert' ) : window && w
      * @param {number} major - The major part of the version (the 3 in 3.1.2)
      * @param {number} minor - The minor part of the version (the 1 in 3.1.2)
      * @param {number} maintenance - The maintenance part of the version (the 2 in 3.1.2)
-     * @param {Object} options
+     * @param {Object} [options]
      */
     constructor( major, minor, maintenance, options ) {
       const {

diff --git a/js/grunt/createSim.js b/js/grunt/createSim.js
@@ -30,7 +30,7 @@ const npmUpdate = require( '../common/npmUpdate' );
 /**
  * @param {string} repo
  * @param {string} author
- * @param {Object} options
+ * @param {Object} [options]
  */
 module.exports = async function( repo, author, options ) {
   const {