diff --git a/src/Shell_Command.php b/src/Shell_Command.php index 9205939..bb1b8bd 100644 --- a/src/Shell_Command.php +++ b/src/Shell_Command.php @@ -1,6 +1,5 @@ ] * : Name of website to run shell on. + * + * ## EXAMPLES + * + * # Open shell for site + * $ ee shell example.com + * */ public function __invoke( $args ) { @@ -45,7 +50,7 @@ public function __invoke( $args ) { /** * Run the command to open shell. * - * @param string $cmd Command to be executed to open shell. + * @param string $cmd Command to be executed to open shell. * @param null|array $descriptors File descriptors for proc. */ private function run( $cmd, $descriptors = null ) { @@ -69,8 +74,10 @@ private function run( $cmd, $descriptors = null ) { /** * Function to check if container supporting shell is present in docker-compose.yml or not. * - * @param string $shell_container Container to be checked. - * @param Object $site Contains relevant site info. + * @param string $shell_container Container to be checked. + * @param EE\Model\Site $site Contains relevant site info. + * + * @throws \EE\ExitException */ private function check_shell_available( $shell_container, $site ) {