docs(api.md): note preloading may be skipped even if enabled (#4077)

dequelabs · Jul 3, 2023 · 481ade0 · 481ade0
1 parent 9f1a3e3
commit 481ade0
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/doc/API.md b/doc/API.md
@@ -621,6 +621,8 @@ The `assets` attribute expects an array of preload(able) constraints to be fetch
 
 The `timeout` attribute in the object configuration is `optional` and has a fallback default value (10000ms). The `timeout` is essential for any network dependent assets that are preloaded, where-in if a given request takes longer than the specified/ default value, the operation is aborted.
 
+Preloading is not applicable to all rules. Even if the `preload` option is enabled, preloading steps may be skipped if no enabled rules require preloading.
+
 ##### Callback Parameter
 
 The callback parameter is a function that will be called when the asynchronous `axe.run` function completes. The callback function is passed two parameters. The first parameter will be an error thrown inside of axe if axe.run could not complete. If axe completed correctly the first parameter will be null, and the second parameter will be the results object.