Merge pull request #591 from wp-cli/copilot/add-command-syntax-explanation

Add argument syntax reference to command documentation

Author: ernilambar

bin/command.php

@@ -649,6 +649,10 @@ private static function gen_cmd_pages( $cmd, $parent = [], $verbose = false ) {
 			}
 			$docs = preg_replace( '/(#?## GLOBAL PARAMETERS).+/s', $replace_global, $docs );
 
+			// Add link to argument syntax documentation after OPTIONS heading.
+			$options_note = 'See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used.';
+			$docs         = preg_replace( '/(### OPTIONS)/', '$1' . PHP_EOL . PHP_EOL . $options_note, $docs );
+
 			$binding['docs'] = $docs;
 		}