doc: argument description

soyuka · soyuka · commit d89c1ae91179 · 2024-10-02T15:05:31.000+02:00
diff --git a/README.md b/README.md
@@ -13,6 +13,7 @@ composer global require --dev soyuka/pmu # ability to link projects globally
 ## Configuration
 
 ```json5
+// composer.json
 {
   "name": "test/monorepo",
   // Specify the projects that are part of your monorepository
diff --git a/src/Command/GraphCommand.php b/src/Command/GraphCommand.php
@@ -26,7 +26,7 @@ protected function configure(): void
     {
         $this->setName('graph')
             ->setDefinition([
-                new InputArgument('projects', InputArgument::IS_ARRAY | InputArgument::OPTIONAL, ''),
+                new InputArgument('projects', InputArgument::IS_ARRAY | InputArgument::OPTIONAL, 'Projects to generate the graph for.'),
             ])
               ->setDescription('Outputs the graph of dependencies in the Dot format');
     }

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ composer global require --dev soyuka/pmu # ability to link projects globally`
`13`	`13`	`## Configuration`
`14`	`14`
`15`	`15`	```json5
	`16`	`+// composer.json`
`16`	`17`	`{`
`17`	`18`	`"name": "test/monorepo",`
`18`	`19`	`// Specify the projects that are part of your monorepository`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ protected function configure(): void`
`26`	`26`	`{`
`27`	`27`	`$this->setName('graph')`
`28`	`28`	`->setDefinition([`
`29`		`- new InputArgument('projects', InputArgument::IS_ARRAY \| InputArgument::OPTIONAL, ''),`
	`29`	`+ new InputArgument('projects', InputArgument::IS_ARRAY \| InputArgument::OPTIONAL, 'Projects to generate the graph for.'),`
`30`	`30`	`])`
`31`	`31`	`->setDescription('Outputs the graph of dependencies in the Dot format');`
`32`	`32`	`}`