TCMN-177 Correction to docblocks for where and all methods

changelog/fix-TCMN-177-correct-ORM-docblocks

@@ -0,0 +1,4 @@
+Significance: minor
+Type: fix
+
+Added more details to `Core_Read_Interface` methods' docblocks to avoid errors in PHPStan. [TCMN-177]

src/Tribe/Repository/Core_Read_Interface.php

@@ -54,10 +54,14 @@ public function by( $key, $value = null );
 	/**
 	 * Just an alias of the `by` method to allow for easier reading.
 	 *
+	 * This method can accept additional arguments as individual, comma-separated
+	 * parameters, which will be passed to the schema.
+	 *
 	 * @since 4.7.19
+	 * @since TBD Added clarification about format for optional additional arguments.
 	 *
-	 * @param string $key
-	 * @param mixed  $value
+	 * @param string $key   The key to query by.
+	 * @param mixed  $value The value associated with the key.
 	 *
 	 * @return Tribe__Repository__Read_Interface
 	 */
@@ -109,13 +113,14 @@ public function found();
 	 *
 	 * @since 4.1.3
 	 * @since 5.2.0 Added the `$return_generator` and `$batch_size` parameters.
+	 * @since TBD Updated `return` to more accurately reflect what can be returned.
 	 *
 	 * @param bool $return_generator Whether to return a generator of post IDs instead of an array of post IDs.
 	 * @param int  $batch_size       The number of post IDs to fetch at a time when using a generator; ignored
 	 *                               if `$return_generator` is false.
 	 *
-	 * @return array<int>|Generator<int> An array of all the matching post IDs, or a generator of them
-	 *                                   if `$return_generator` is true.
+	 * @return array<int|WP_Post|object>|Generator<int|WP_Post|object> An array of all the matching post IDs, or a generator of them
+	 *                                                                 if `$return_generator` is true.
 	 */
 	public function all( $return_generator = false, int $batch_size = 50 );