Skip to content

Commit f8b96bf

Browse files
committed
Update doc blocks
1 parent 4a83de4 commit f8b96bf

File tree

1 file changed

+4
-11
lines changed

1 file changed

+4
-11
lines changed

src/ExerciseRunner/CustomVerifyingRunner.php

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,8 @@ public function getRequiredChecks()
4646
}
4747

4848
/**
49-
* Verify a solution to an exercise. Verification involves executing the reference solution
50-
* and the student's solution and comparing their output. If the output is the same
51-
* an instance of `PhpSchool\PhpWorkshop\Result\SuccessInterface` should be returned, if the output
52-
* is not the same, or something else went wrong then an instance of
53-
* `\PhpSchool\PhpWorkshop\Result\FailureInterface` should be returned.
54-
*
55-
* Other things that could go wrong include the student's solution returning a non-zero
56-
* exit code, or a notice/warning being exhibited.
49+
* Delegate to the exercise for verifying. Verifying could mean checking that a program was installed or that some
50+
* other arbitrary task was performed.
5751
*
5852
* @param Input $input The command line arguments passed to the command.
5953
* @return ResultInterface The result of the check.
@@ -64,9 +58,8 @@ public function verify(Input $input)
6458
}
6559

6660
/**
67-
* Run a solution to an exercise. This simply run's the student's solution with the correct input from the exercise
68-
* (such as the CLI arguments) and prints the output directly. This allows the student to have the environment
69-
* setup for them including getting a different set of arguments each time (if the exercise supports that).
61+
* Running a custom verifying exercise does nothing. There is no program required, therefore there is nothing
62+
* to run.
7063
*
7164
* @param Input $input The command line arguments passed to the command.
7265
* @param OutputInterface $output A wrapper around STDOUT.

0 commit comments

Comments
 (0)