Merge pull request #557 from kinow/minor-updates

Fix typos and jsdocs tags
cylc · Dec 9, 2020 · 782dd3f · 782dd3f
2 parents 0c088f9 + d6e67f2
commit 782dd3f
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 3 deletions.
diff --git a/src/components/cylc/workflow/lumino-widget.js b/src/components/cylc/workflow/lumino-widget.js
@@ -79,7 +79,13 @@ export default class LuminoWidget extends Widget {
    * Event details returned for a `CustomEvent`.
    *
    * @link https://developer.mozilla.org/en-US/docs/Web/Guide/Events/Creating_and_triggering_events
-   * @returns {{closable: boolean, name: string, id: string}}
+   * @returns {{
+   *   detail: {
+   *     id: string,
+   *     name: string,
+   *     closable: boolean
+   *   }
+   * }}
    * @private
    */
   _getEventDetails () {

diff --git a/src/graphql/queries.js b/src/graphql/queries.js
@@ -182,7 +182,7 @@ subscription {
 
 /**
  * Query used to retrieve data for the GScan sidebar.
- * @type {DocumentNode}
+ * @type {string}
  */
 const GSCAN_QUERY = `
 subscription {

diff --git a/src/model/WorkflowState.model.js b/src/model/WorkflowState.model.js
@@ -39,6 +39,7 @@ class WorkflowState extends Enumify {
   /**
    * Constructor.
    * @param {String} name
+   * @param {String} icon
    */
   constructor (name, icon) {
     super()

diff --git a/src/utils/aotf.js b/src/utils/aotf.js
@@ -16,7 +16,7 @@
 
 /*
  * Functionality for introspecting mutations, associating them with Cylc
- * objects, filtering and calling mutatons.
+ * objects, filtering and calling mutations.
  *
  * (AOTF == Api On The Fly)
  */