Refine doc block

westonruter · westonruter · commit cd65bd3d082e · 2025-08-04T10:20:23.000-07:00
diff --git a/plugins/optimization-detective/detect-loader.js b/plugins/optimization-detective/detect-loader.js
@@ -1,7 +1,9 @@
 /**
- * Loads the detect logic after the page has loaded to prevent a high-priority script module network request from competing with other critical resources.
+ * Loads the detect module after the page has loaded.
  *
- * This JavaScript file must be contain a single top-level function which is not exported. The file is inlined as part of another module which wraps the module in an IIFE.
+ * This prevents a high-priority script module network request from competing with other critical resources. This
+ * JavaScript file must contain a single top-level function which is not exported. The file is inlined as part of
+ * another module which wraps the function in an IIFE.
  *
  * @param {string} detectSrc
  * @param {Object} detectArgs

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,9 @@`
`1`	`1`	`/**`
`2`		`- * Loads the detect logic after the page has loaded to prevent a high-priority script module network request from competing with other critical resources.`
	`2`	`+ * Loads the detect module after the page has loaded.`
`3`	`3`	`*`
`4`		`- * This JavaScript file must be contain a single top-level function which is not exported. The file is inlined as part of another module which wraps the module in an IIFE.`
	`4`	`+ * This prevents a high-priority script module network request from competing with other critical resources. This`
	`5`	`+ * JavaScript file must contain a single top-level function which is not exported. The file is inlined as part of`
	`6`	`+ * another module which wraps the function in an IIFE.`
`5`	`7`	`*`
`6`	`8`	`* @param {string} detectSrc`
`7`	`9`	`* @param {Object} detectArgs`