Merge pull request #6116 from ampproject/fix/6089-mark-optimizer-cli-…

…as-experimental Mark optimizer CLI commands as experimental in their docblock
ampproject · Apr 25, 2021 · 8d1425e · 8d1425e
2 parents d00dc44 + e377477
commit 8d1425e
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 5 deletions.
diff --git a/src/Cli/OptimizerCommand.php b/src/Cli/OptimizerCommand.php
@@ -17,7 +17,11 @@
 use WP_CLI;
 
 /**
- * Commands that deal with the AMP optimizer.
+ * Commands that deal with the AMP optimizer. (EXPERIMENTAL)
+ *
+ * Note: The Optimizer CLI commands are to be considered experimental, as
+ * the output they produce is currently not guaranteed to be consistent
+ * with the corresponding output from the web server code path.
  *
  * @since 2.1.0
  * @internal
@@ -50,7 +54,11 @@ public function __construct( OptimizerService $optimizer_service ) {
 	}
 
 	/**
-	 * Run a file through the AMP Optimizer.
+	 * Run a file through the AMP Optimizer. (EXPERIMENTAL)
+	 *
+	 * Note: The Optimizer CLI commands are to be considered experimental, as
+	 * the output they produce is currently not guaranteed to be consistent
+	 * with the corresponding output from the web server code path.
 	 *
 	 * ## OPTIONS
 	 *

diff --git a/src/Cli/TransformerCommand.php b/src/Cli/TransformerCommand.php
@@ -17,7 +17,11 @@
 use WP_CLI\Utils;
 
 /**
- * Commands that deal with the transformers registered with the AMP optimizer.
+ * Commands that deal with the transformers registered with the AMP optimizer. (EXPERIMENTAL)
+ *
+ * Note: The Optimizer CLI commands are to be considered experimental, as
+ * the output they produce is currently not guaranteed to be consistent
+ * with the corresponding output from the web server code path.
  *
  * @since 2.1.0
  * @internal
@@ -48,7 +52,11 @@ public function __construct( Configuration $configuration ) {
 	}
 
 	/**
-	 * List the transformers registered with the AMP Optimizer.
+	 * List the transformers registered with the AMP Optimizer. (EXPERIMENTAL)
+	 *
+	 * Note: The Optimizer CLI commands are to be considered experimental, as
+	 * the output they produce is currently not guaranteed to be consistent
+	 * with the corresponding output from the web server code path.
 	 *
 	 * ## OPTIONS
 	 *
@@ -135,7 +143,11 @@ function ( $transformer_class ) {
 	}
 
 	/**
-	 * List the configuration of a given transformer.
+	 * List the configuration of a given transformer. (EXPERIMENTAL)
+	 *
+	 * Note: The Optimizer CLI commands are to be considered experimental, as
+	 * the output they produce is currently not guaranteed to be consistent
+	 * with the corresponding output from the web server code path.
 	 *
 	 * ## OPTIONS
 	 *