Rename string to jsonString to avoid potential type confusion

Author: westonruter

plugins/optimization-detective/detect.js

@@ -330,13 +330,13 @@ function extendElementData( xpath, properties ) {
 }
 
 /**
- * Compresses a string using CompressionStream API.
+ * Compresses a (JSON) string using CompressionStream API.
  *
- * @param {string} string - String to compress.
+ * @param {string} jsonString - JSON string to compress.
  * @return {Promise<Blob>} Compressed data.
  */
-async function compress( string ) {
-	const encodedData = new TextEncoder().encode( string );
+async function compress( jsonString ) {
+	const encodedData = new TextEncoder().encode( jsonString );
 	const compressedDataStream = new Blob( [ encodedData ] )
 		.stream()
 		.pipeThrough( new CompressionStream( 'gzip' ) );

plugins/optimization-detective/storage/data.php

@@ -486,7 +486,7 @@ function od_get_maximum_url_metric_size(): int {
 			esc_html( "Filter: 'od_maximum_url_metric_size'" ),
 			esc_html(
 				sprintf(
-				/* translators: %s: size */
+					/* translators: %s: size */
 					__( 'Invalid size "%s". Must be greater than zero.', 'optimization-detective' ),
 					$size
 				)

plugins/optimization-detective/storage/rest-api.php

@@ -353,7 +353,7 @@ function od_trigger_page_cache_invalidation( int $cache_purge_post_id ): void {
  * @param mixed           $result  Response to replace the requested version with. Can be anything a normal endpoint can return, or null to not hijack the request.
  * @param WP_REST_Server  $server  Server instance.
  * @param WP_REST_Request $request Request used to generate the response.
- * @return mixed Response to replace the requested version with.
+ * @return mixed Passed through $result if successful, or otherwise a WP_Error.
  */
 function od_decompress_rest_request_body( $result, WP_REST_Server $server, WP_REST_Request $request ) {
 	if (