docs: fix building api-docs (#1929)

dequelabs · Dec 10, 2019 · e1ecd8e · e1ecd8e
1 parent 7d9da82
commit e1ecd8e
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -74,6 +74,14 @@ jobs:
       - run: npm run build
       - run: npm run test:locales
 
+  # Test api docs can be built
+  build_api_docs:
+    <<: *defaults
+    steps:
+      - checkout
+      - <<: *restore_dependency_cache
+      - run: npm run api-docs
+
   # Test newest axe-core version rule help docs are active (only on
   # master prs)
   test_rule_help_version:
@@ -138,6 +146,9 @@ workflows:
       - test_locales:
           requires:
             - test
+      - build_api_docs:
+          requires:
+            - test
       - test_rule_help_version:
           requires:
             - test
@@ -148,6 +159,7 @@ workflows:
             - test
             - test_examples
             - test_locales
+            - build_api_docs
             - test_rule_help_version
           filters:
             branches:
@@ -160,6 +172,7 @@ workflows:
             - test
             - test_examples
             - test_locales
+            - build_api_docs
           filters:
             branches:
               only: develop
@@ -170,6 +183,7 @@ workflows:
             - test
             - test_examples
             - test_locales
+            - build_api_docs
             - test_rule_help_version
             - hold
           filters:

diff --git a/lib/core/utils/preload-cssom.js b/lib/core/utils/preload-cssom.js
@@ -121,7 +121,7 @@ function getCssomForAllRootNodes(rootNodes, convertDataToStylesheet) {
 /**
  * Flatten CSSOM assets
  *
- * @param {[Array<Array<...>]} assets nested assets (varying depth)
+ * @param {Array.<Object[]>} assets nested assets (varying depth)
  * @returns {Array<Object>} Array of CSSOM object
  */
 function flattenAssets(assets) {