Code review ammends

Author: AydinHassan

src/Application.php

@@ -76,7 +76,7 @@ public function __construct($workshopTitle, $diConfigFile)
     }
 
     /**
-     * Register a custom check with the application. Exercises will only be use the check
+     * Register a custom check with the application. Exercises will only be able to use the check
      * if it has been registered here.
      *
      * @param string $check The FQCN of the check
@@ -113,7 +113,7 @@ public function addResult($resultClass, $resultRendererClass)
     }
 
     /**
-     * Add an ASCII art logo to the application. This will be displayed a the top of them menu. It will be
+     * Add an ASCII art logo to the application. This will be displayed at the top of them menu. It will be
      * automatically padded to sit in the middle.
      *
      * @param string $logo The logo

src/Check/CheckRepository.php

@@ -65,7 +65,7 @@ public function getByClass($class)
     }
 
     /**
-     * Query whether a check instance exists in this repository via it's class name.
+     * Query whether a check instance exists in this repository via its class name.
      *
      * @param string $class
      * @return bool

src/Check/DatabaseCheck.php

@@ -15,7 +15,7 @@
 
 /**
  * This check sets up a database and a `PDO` object. It prepends the database DSN as a CLI argument to the student's
- * solution so they can connect to the database. The PDO object is passed to the exercise before and after the
+ * solution so they can connect to the database. The `PDO` object is passed to the exercise before and after the
  * student's solution has been executed, allowing you to first seed the database and then verify the contents of the
  * database.
  *

src/Check/FileExistsCheck.php

@@ -17,7 +17,7 @@
 class FileExistsCheck implements SimpleCheckInterface
 {
     /**
-     * Return the check's name
+     * Return the check's name.
      *
      * @return string
      */

src/Check/FunctionRequirementsCheck.php

@@ -39,7 +39,7 @@ public function __construct(Parser $parser)
     }
 
     /**
-     * Return the check's name
+     * Return the check's name.
      *
      * @return string
      */

src/Check/PhpLintCheck.php

@@ -29,7 +29,7 @@ public function getName()
     }
 
     /**
-     * Simply check the student's solution can be linted with `php -l`
+     * Simply check the student's solution can be linted with `php -l`.
      *
      * @param ExerciseInterface $exercise The exercise to check against.
      * @param string $fileName The absolute path to the student's solution.

src/CodeInsertion.php

@@ -44,7 +44,7 @@ class CodeInsertion
     private $code;
 
     /**
-     * Accepts the type on insertion, either static::TYPE_BEFORE or static::TYPE_AFTER
+     * Accepts the type of insertion, either `static::TYPE_BEFORE` or `static::TYPE_AFTER`
      * and a string containing the code to be inserted.
      *
      * @param string $type
@@ -60,7 +60,7 @@ public function __construct($type, $code)
     }
 
     /**
-     * Get the type of insertion, either static::TYPE_BEFORE or static::TYPE_AFTER.
+     * Get the type of insertion, either `static::TYPE_BEFORE` or `static::TYPE_AFTER`.
      *
      * @return string
      */
@@ -70,7 +70,7 @@ public function getType()
     }
 
     /**
-     * Get a string containing the code be inserted
+     * Get a string containing the code be inserted.
      *
      * @return string
      */

src/CodePatcher.php

@@ -12,8 +12,8 @@
 use PhpSchool\PhpWorkshop\Exercise\SubmissionPatcher;
 
 /**
- * Service to apply patches to a students solution. Accepts a default patch via the constructor.
- * Patched are pulled from the exercise (if it implements SubmissionPatchable) and applied to the
+ * Service to apply patches to a student's solution. Accepts a default patch via the constructor.
+ * Patches are pulled from the exercise (if it implements `SubmissionPatchable`) and applied to the
  * given code.
  *
  * @package PhpSchool\PhpWorkshop
@@ -37,7 +37,7 @@ class CodePatcher
     private $defaultPatch;
 
     /**
-     * This service requires an instance of Parser and Standard. These services allow
+     * This service requires an instance of `Parser` and `Standard`. These services allow
      * to parse code to an AST and to print code from an AST.
      *
      * The service also accepts a default patch. This allows a workshop to apply a patch
@@ -60,7 +60,7 @@ public function __construct(Parser $parser, Standard $printer, Patch $defaultPat
      *
      * If there is a default patch, the students solution is patched with that.
      *
-     * If the exercise implements SubmissionPatchable then the patch is pulled from it and applied to
+     * If the exercise implements `SubmissionPatchable` then the patch is pulled from it and applied to
      * the students solution.
      *
      * @param ExerciseInterface $exercise

src/CommandDefinition.php

@@ -4,7 +4,7 @@
 
 /**
  * Represents a command in the workshop framework. Simply consists of a
- * command name, required arguments and either a service name of callable to
+ * command name, required arguments and either a service name or callable to
  * execute when the command is run.
  *
  * @package PhpSchool\PhpWorkshop
@@ -40,7 +40,7 @@ public function __construct($name, array $args, $commandCallable)
     }
 
     /**
-     * Get the name of the command
+     * Get the name of the command.
      *
      * @return string
      */
@@ -50,7 +50,7 @@ public function getName()
     }
 
     /**
-     * Get the list of required arguments
+     * Get the list of required arguments.
      *
      * @return array
      */
@@ -60,7 +60,7 @@ public function getRequiredArgs()
     }
 
     /**
-     * Get the callable associated with this command
+     * Get the callable associated with this command.
      *
      * @return string|callable
      */

src/CommandRouter.php

@@ -9,7 +9,7 @@
 
 /**
  * Parses $argv (or passed array) and attempts to find a command
- * which is suitable for what was typed on the cli. It then executed the callable
+ * which is suitable for what was typed on the cli. It then executes the callable
  * associated with that command definition.
  *
  * @package PhpSchool\PhpWorkshop
@@ -34,7 +34,7 @@ class CommandRouter
     private $container;
 
     /**
-     * Accepts an array of CommandDefinition's which represent the application. Also takes a default
+     * Accepts an array of `CommandDefinition`'s which represent the application. Also takes a default
      * (name of one of the commands) which will be used if the workshop was invoked with no arguments.
      *
      * Also accepts an instance of the container so it can look for services in there which may by defined
@@ -70,7 +70,7 @@ private function addCommand(CommandDefinition $c)
     }
 
     /**
-     * Attempts to route the command. Parses $argv (or a given array), extracting the command name and
+     * Attempts to route the command. Parses `$argv` (or a given array), extracting the command name and
      * arguments. Using the command name, the command definition is looked up.
      *
      * The number of arguments are validated against the required arguments for the command