CLI-1406: Command documentation markup

acquia · Nov 21, 2024 · 1b78ba0 · 1b78ba0
1 parent 10027cb
commit 1b78ba0
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/Command/Self/MakeDocsCommand.php b/src/Command/Self/MakeDocsCommand.php
@@ -7,6 +7,7 @@
 use Acquia\Cli\Command\CommandBase;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Formatter\OutputFormatter;
 use Symfony\Component\Console\Helper\DescriptorHelper;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
@@ -19,7 +20,7 @@ final class MakeDocsCommand extends CommandBase
     protected function configure(): void
     {
         $this->addOption('format', 'f', InputOption::VALUE_OPTIONAL, 'The format to describe the docs in.', 'rst');
-        $this->addOption('dump', 'd', InputOption::VALUE_OPTIONAL, 'Dump docs to directory');
+        $this->addOption('dump', 'd', InputOption::VALUE_OPTIONAL, 'Dump docs to directory (implies JSON format)');
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
@@ -46,6 +47,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 continue;
             }
             $filename = $command['name'] . '.json';
+            $command['help'] = (new OutputFormatter())->format($command['help']);
             $index[] = [
                 'command' => $command['name'],
                 'help' => $command['help'],