fix(option): return Option<never> for Option::none() (#415)

azjezz · Jul 18, 2023 · 741bfa5 · 741bfa5
1 parent 1d015ad
commit 741bfa5
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 7 deletions.
diff --git a/docs/component/option.md b/docs/component/option.md
@@ -13,7 +13,7 @@
 #### `Functions`
 
 - [from_nullable](./../../src/Psl/Option/from_nullable.php#L16)
-- [none](./../../src/Psl/Option/none.php#L14)
+- [none](./../../src/Psl/Option/none.php#L12)
 - [some](./../../src/Psl/Option/some.php#L16)
 
 #### `Classes`

diff --git a/src/Psl/Option/Option.php b/src/Psl/Option/Option.php
@@ -38,12 +38,11 @@ public static function some(mixed $value): Option
     /**
      * Create an option with none value.
      *
-     * @template Tn
-     *
-     * @return Option<Tn>
+     * @return Option<never>
      */
     public static function none(): Option
     {
+        /** @var Option<never> */
         return new self(null);
     }
 

diff --git a/src/Psl/Option/none.php b/src/Psl/Option/none.php
@@ -7,9 +7,7 @@
 /**
  * Create an option with none value.
  *
- * @template T
- *
- * @return Option<T>
+ * @return Option<never>
  */
 function none(): Option
 {