Renamed argument 'description' to 'name'.

ulrichsg · ulrichsg · commit 3743fc63890e · 2014-12-28T10:59:01.000+01:00
diff --git a/src/Ulrichsg/Getopt/Argument.php b/src/Ulrichsg/Getopt/Argument.php
@@ -9,7 +9,7 @@ class Argument
     /** @var callable */
     private $validation;
     /** @var string */
-    private $description;
+    private $name;
 
     /**
      * Creates a new argument.
@@ -18,15 +18,15 @@ class Argument
      * @param callable|null $validation a validation function (optional)
      * @throws \InvalidArgumentException
      */
-    public function __construct($default = null, $validation = null, $description = "arg")
+    public function __construct($default = null, $validation = null, $name = "arg")
     {
         if (!is_null($default)) {
             $this->setDefaultValue($default);
         }
         if (!is_null($validation)) {
             $this->setValidation($validation);
         }
-        $this->description = $description;
+        $this->name = $name;
     }
 
     /**
@@ -104,12 +104,12 @@ public function getDefaultValue()
     }
 
     /**
-     * Retrieve the descriptopm
+     * Retrieve the argument name
      *
      * @return string
      */
-    public function getDescription()
+    public function getName()
     {
-        return $this->description;
+        return $this->name;
     }
-}
+}
diff --git a/src/Ulrichsg/Getopt/Getopt.php b/src/Ulrichsg/Getopt/Getopt.php
@@ -225,10 +225,10 @@ public function getHelpText($padding = 25)
                     $mode = '';
                     break;
                 case self::REQUIRED_ARGUMENT:
-                    $mode = "<".$option->getArgument()->getDescription().">";
+                    $mode = "<".$option->getArgument()->getName().">";
                     break;
                 case self::OPTIONAL_ARGUMENT:
-                    $mode = "[<".$option->getArgument()->getDescription().">]";
+                    $mode = "[<".$option->getArgument()->getName().">]";
                     break;
             }
             $short = ($option->short()) ? '-'.$option->short() : '';

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ class Argument`
`9`	`9`	`/** @var callable */`
`10`	`10`	`private $validation;`
`11`	`11`	`/** @var string */`
`12`		`- private $description;`
	`12`	`+ private $name;`
`13`	`13`
`14`	`14`	`/**`
`15`	`15`	`* Creates a new argument.`
`@@ -18,15 +18,15 @@ class Argument`
`18`	`18`	`* @param callable\|null $validation a validation function (optional)`
`19`	`19`	`* @throws \InvalidArgumentException`
`20`	`20`	`*/`
`21`		`- public function __construct($default = null, $validation = null, $description = "arg")`
	`21`	`+ public function __construct($default = null, $validation = null, $name = "arg")`
`22`	`22`	`{`
`23`	`23`	`if (!is_null($default)) {`
`24`	`24`	`$this->setDefaultValue($default);`
`25`	`25`	`}`
`26`	`26`	`if (!is_null($validation)) {`
`27`	`27`	`$this->setValidation($validation);`
`28`	`28`	`}`
`29`		`- $this->description = $description;`
	`29`	`+ $this->name = $name;`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`/**`
`@@ -104,12 +104,12 @@ public function getDefaultValue()`
`104`	`104`	`}`
`105`	`105`
`106`	`106`	`/**`
`107`		`- * Retrieve the descriptopm`
	`107`	`+ * Retrieve the argument name`
`108`	`108`	`*`
`109`	`109`	`* @return string`
`110`	`110`	`*/`
`111`		`- public function getDescription()`
	`111`	`+ public function getName()`
`112`	`112`	`{`
`113`		`- return $this->description;`
	`113`	`+ return $this->name;`
`114`	`114`	`}`
`115`		`-}`
	`115`	`+}`