documentation: Add examples to Result methods

Author: mathroc

README.md

@@ -104,7 +104,7 @@ function writeInFile(string $filepath, string $data): Result {
     $res = file_put_contents($filepath, $data);
 
     if ($res === false) {
-        return Result\err("failed to write in $path");
+        return Result\err("failed to write in $filepath");
     }
 
     return Result\ok($res);

composer.json

@@ -32,7 +32,7 @@
         "vimeo/psalm": "^4.22",
         "symfony/finder": "^6.1",
         "symfony/console": "^6.1",
-        "texthtml/doctest": "^0.1.0"
+        "texthtml/doctest": "^0.2"
     },
     "config": {
         "allow-plugins": {

composer.lock

@@ -12,8 +12,6 @@
  * # Examples
  *
  * ```
- * use TH\Maybe\Option;
- *
  * // @return Option<float>
  * function divide(float $numerator, float $denominator): Option {
  *   if ($denominator === 0.0) {
@@ -50,15 +48,11 @@ interface Option extends \IteratorAggregate
      * # Examples
      *
      * ```
-     * use TH\Maybe\Option;
-     *
      * $x = Option\some("value");
      * self::assertSame($x->expect("fruits are healthy"), "value");
      * ```
      *
      * ```
-     * use TH\Maybe\Option;
-     *
      * // @var Option<string> $x
      * $x = Option\none();
      *
@@ -78,15 +72,11 @@ public function expect(string $message): mixed;
      * # Examples
      *
      * ```
-     * use TH\Maybe\Option;
-     *
      * $x = Option\some("value");
      * self::assertSame($x->unwrap(), "value");
      * ```
      *
      * ```
-     * use TH\Maybe\Option;
-     *
      * // @var Option<string> $x
      * $x = Option\none();
      *
@@ -105,8 +95,6 @@ public function unwrap(): mixed;
      * # Examples
      *
      * ```
-     * use TH\Maybe\Option;
-     *
      * self::assertSame(Option\some("car")->unwrapOr("bike"), "car");
      * self::assertSame(Option\none()->unwrapOr("bike"), "bike");
      * ```
@@ -122,8 +110,6 @@ public function unwrapOr(mixed $default): mixed;
      * # Examples
      *
      * ```
-     * use TH\Maybe\Option;
-     *
      * $k = 10;
      * self::assertSame(Option\some(4)->unwrapOrElse(fn () => 2 * $k), 4);
      * self::assertSame(Option\none()->unwrapOrElse(fn () => 2 * $k), 20);
@@ -141,8 +127,6 @@ public function unwrapOrElse(callable $default): mixed;
      * # Examples
      *
      * ```
-     * use TH\Maybe\Option;
-     *
      * $option = Option\some(4);
      * self::assertSame($option->inspect(fn (int $n) => printf("got: %d", $n)), $option); // @prints got: 4
      * // @var Option<int> $option
@@ -161,8 +145,6 @@ public function inspect(callable $callback): self;
      * # Examples
      *
      * ```
-     * use TH\Maybe\Option;
-     *
      * $x = Option\some(2);
      * // @var Option<string> $y
      * $y = Option\none();
@@ -193,8 +175,6 @@ public function and(Option $right): Option;
      * # Examples
      *
      * ```
-     * use TH\Maybe\Option;
-     *
      * // @return Option<int>
      * function to_exact_int(float $f): Option {
      *   $i = (int) $f;
@@ -218,8 +198,6 @@ public function andThen(callable $right): Option;
      * # Examples
      *
      * ```
-     * use TH\Maybe\Option;
-     *
      * $x = Option\some(2);
      * // @var Option<int> $y
      * $y = Option\none();
@@ -252,8 +230,6 @@ public function or(Option $right): Option;
      * # Examples
      *
      * ```
-     * use TH\Maybe\Option;
-     *
      * // @return Option<string>
      * function nobody(): Option {
      *   return Option\none();
@@ -280,8 +256,6 @@ public function orElse(callable $right): Option;
      * # Examples
      *
      * ```
-     * use TH\Maybe\Option;
-     *
      * $x = Option\some(2);
      * // @var Option<int> $y
      * $y = Option\none();
@@ -311,8 +285,6 @@ public function xor(Option $right): Option;
      * # Examples
      *
      * ```
-     * use TH\Maybe\Option;
-     *
      * $x = Option\some(2);
      * self::assertTrue($x->contains(2));
      * $x = Option\some(3);
@@ -332,8 +304,6 @@ public function contains(mixed $value, bool $strict = true): bool;
      * # Examples
      *
      * ```
-     * use TH\Maybe\Option;
-     *
      * $isEven = fn(int $n) => $n % 2 === 0;
      *
      * self::assertSame(Option\none()->filter($isEven), Option\none());
@@ -352,8 +322,6 @@ public function filter(callable $predicate): Option;
      * # Examples
      *
      * ```
-     * use TH\Maybe\Option;
-     *
      * $maybeSomeString = Option\some("Hello, World!");
      * $maybeSomeLen = $maybeSomeString->map(strlen(...));
      * self::assertEq($maybeSomeLen, Option\some(13));
@@ -372,8 +340,6 @@ public function map(callable $callback): Option;
      * # Examples
      *
      * ```
-     * use TH\Maybe\Option;
-     *
      * $x = Option\some("foo");
      * self::assertSame($x->mapOr(strlen(...), 42), 3);
      * // @var Option<string> $x
@@ -395,8 +361,6 @@ public function mapOr(callable $callback, mixed $default): mixed;
      * # Examples
      *
      * ```
-     * use TH\Maybe\Option;
-     *
      * $k = 21;
      * $x = Option\some("foo");
      * self::assertSame($x->mapOrElse(strlen(...), fn () => 2 * $k), 3);
@@ -421,8 +385,6 @@ public function mapOrElse(callable $callback, callable $default): mixed;
      * # Examples
      *
      * ```
-     * use TH\Maybe\Option;
-     *
      * $x = Option\some(1);
      * $y = Option\some("hi");
      * // @var Option<int> $z
@@ -443,7 +405,7 @@ public function zip(Option $option): Option;
      * # Examples
      *
      * ```
-     * use TH\Maybe\{Option, Result};
+     * use TH\Maybe\Result;
      *
      * self::assertEq(Option\some("foo")->okOr(0), Result\ok("foo"));
      * self::assertEq(Option\none()->okOr(0), Result\err(0));
@@ -462,7 +424,7 @@ public function okOr(mixed $err): Result;
      * # Examples
      *
      * ```
-     * use TH\Maybe\{Option, Result};
+     * use TH\Maybe\Result;
      *
      * self::assertEq(Option\some("foo")->okOrElse(fn () => 0), Result\ok("foo"));
      * self::assertEq(Option\none()->okOrElse(fn () => 0), Result\err(0));