PHPStan: Add DocComments and ignore lines that purposefully fail static analysis

Author: zanbaldwin

src/HttpClient/HttpPluginClientBuilder.php

@@ -27,6 +27,7 @@ class HttpPluginClientBuilder
     private $pluginClient;
     /** @var RequestFactory|RequestFactoryInterface */
     private $requestFactory;
+    /** @var StreamFactoryInterface */
     private $streamFactory;
     /** @var Plugin[] */
     private $plugins = [];
@@ -73,7 +74,7 @@ public function addPlugin(Plugin $plugin)
     }
 
     /**
-     * @param string $pluginClass
+     * @param class-string $pluginClass
      */
     public function removePlugin($pluginClass)
     {

tests/HttpClient/HttpPluginClientBuilderTest.php

@@ -26,6 +26,7 @@ public function testInvalidRequestFactory(): void
     {
         $this->expectException(\TypeError::class);
         $definitelyNotARequestFactory = new \stdClass;
+        /** @phpstan-ignore-next-line We are passing in an invalid type on purpose. */
         new HttpPluginClientBuilder(new MockClient, $definitelyNotARequestFactory);
     }
 
@@ -72,7 +73,9 @@ public function matches(RequestInterface $request): bool
     public static function provideRequestFactories(): iterable
     {
         yield [null];
+        // Http\Message\RequestFactory
         yield [new GuzzleMessageFactory];
+        // Psr\Http\Message\RequestFactoryInterface
         yield [new HttpFactory];
     }
 }