refactor(README): update code comments

- Add strict_types declaration - Update code comments for better readability
guanguans · Apr 1, 2024 · f3ffb4a · f3ffb4a
1 parent 5922972
commit f3ffb4a
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/README-zh_CN.md b/README-zh_CN.md
@@ -513,12 +513,22 @@ SQL
 ```php
 <?php
 
+declare(strict_types=1);
+
 namespace Guanguans\LaravelSoar\Contracts;
 
 use Illuminate\Support\Collection;
 
 interface Output
 {
+    /**
+     * @param \Illuminate\Console\Events\CommandFinished|\Symfony\Component\HttpFoundation\Response $dispatcher
+     */
+    public function shouldOutput($dispatcher): bool;
+
+    /**
+     * @param \Illuminate\Console\Events\CommandFinished|\Symfony\Component\HttpFoundation\Response $dispatcher
+     */
     public function output(Collection $scores, $dispatcher);
 }
 ```

diff --git a/README.md b/README.md
@@ -514,12 +514,22 @@ SQL
 ```php
 <?php
 
+declare(strict_types=1);
+
 namespace Guanguans\LaravelSoar\Contracts;
 
 use Illuminate\Support\Collection;
 
 interface Output
 {
+    /**
+     * @param \Illuminate\Console\Events\CommandFinished|\Symfony\Component\HttpFoundation\Response $dispatcher
+     */
+    public function shouldOutput($dispatcher): bool;
+
+    /**
+     * @param \Illuminate\Console\Events\CommandFinished|\Symfony\Component\HttpFoundation\Response $dispatcher
+     */
     public function output(Collection $scores, $dispatcher);
 }
 ```