Merge pull request #61 from Yoast/JRF/docs-various-updates

Docs: various improvements
Yoast · Sep 23, 2023 · 88ec1b8 · 88ec1b8
2 parents 7d83656 + 9f0dd80
commit 88ec1b8
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 16 deletions.
diff --git a/src/WPIntegration/Autoload.php b/src/WPIntegration/Autoload.php
@@ -27,7 +27,7 @@ final class Autoload {
 	/**
 	 * A list of the classes this autoloader handles.
 	 *
-	 * @var string[] => true
+	 * @var array<string, true>
 	 */
 	private static $supported_classes = [
 		'PHPUnit\\Framework\\MockObject\\Builder\\NamespaceMatch'  => true,

diff --git a/src/WPIntegration/TestCase.php b/src/WPIntegration/TestCase.php
@@ -59,6 +59,8 @@ abstract class TestCase extends WP_UnitTestCase {
 
 	/**
 	 * Wrapper method for the `set_up_before_class()` method for forward-compatibility with WP 5.9.
+	 *
+	 * @return void
 	 */
 	public static function setUpBeforeClass() {
 		parent::setUpBeforeClass();
@@ -67,6 +69,8 @@ public static function setUpBeforeClass() {
 
 	/**
 	 * Wrapper method for the `tear_down_after_class()` method for forward-compatibility with WP 5.9.
+	 *
+	 * @return void
 	 */
 	public static function tearDownAfterClass() {
 		static::tear_down_after_class();
@@ -75,6 +79,8 @@ public static function tearDownAfterClass() {
 
 	/**
 	 * Wrapper method for the `set_up()` method for forward-compatibility with WP 5.9.
+	 *
+	 * @return void
 	 */
 	public function setUp() {
 		parent::setUp();
@@ -83,6 +89,8 @@ public function setUp() {
 
 	/**
 	 * Wrapper method for the `tear_down()` method for forward-compatibility with WP 5.9.
+	 *
+	 * @return void
 	 */
 	public function tearDown() {
 		$this->tear_down();
@@ -91,6 +99,8 @@ public function tearDown() {
 
 	/**
 	 * Wrapper method for the `assert_pre_conditions()` method for forward-compatibility with WP 5.9.
+	 *
+	 * @return void
 	 */
 	protected function assertPreConditions() {
 		parent::assertPreConditions();
@@ -99,6 +109,8 @@ protected function assertPreConditions() {
 
 	/**
 	 * Wrapper method for the `assert_post_conditions()` method for forward-compatibility with WP 5.9.
+	 *
+	 * @return void
 	 */
 	protected function assertPostConditions() {
 		parent::assertPostConditions();
@@ -107,31 +119,43 @@ protected function assertPostConditions() {
 
 	/**
 	 * Placeholder method for forward-compatibility with WP 5.9.
+	 *
+	 * @return void
 	 */
 	public static function set_up_before_class() {}
 
 	/**
 	 * Placeholder method for forward-compatibility with WP 5.9.
+	 *
+	 * @return void
 	 */
 	public static function tear_down_after_class() {}
 
 	/**
 	 * Placeholder method for forward-compatibility with WP 5.9.
+	 *
+	 * @return void
 	 */
 	protected function set_up() {}
 
 	/**
 	 * Placeholder method for forward-compatibility with WP 5.9.
+	 *
+	 * @return void
 	 */
 	protected function tear_down() {}
 
 	/**
 	 * Placeholder method for forward-compatibility with WP 5.9.
+	 *
+	 * @return void
 	 */
 	protected function assert_pre_conditions() {}
 
 	/**
 	 * Placeholder method for forward-compatibility with WP 5.9.
+	 *
+	 * @return void
 	 */
 	protected function assert_post_conditions() {}
 }
diff --git a/tests/BrainMonkey/TestCaseTest.php b/tests/BrainMonkey/TestCaseTest.php
@@ -182,7 +182,7 @@ public function testMakeDoubleForUnavailableClass( $class_name ) {
 	/**
 	 * Data provider.
 	 *
-	 * @return array
+	 * @return array<string, array<string>>
 	 */
 	public function dataMakeDoubleForUnavailableClass() {
 		return [
@@ -218,7 +218,7 @@ public function testMakeDoubleForUnavailableClassThrowsExceptionWithInvalidName(
 	/**
 	 * Data provider.
 	 *
-	 * @return array
+	 * @return array<string, array<string>>
 	 */
 	public function dataMakeDoubleForUnavailableClassThrowsExceptionWithInvalidName() {
 		return [

diff --git a/tests/BrainMonkey/YoastTestCaseTest.php b/tests/BrainMonkey/YoastTestCaseTest.php
@@ -28,7 +28,7 @@ public function testStubGetBlogInfo( $show, $expected ) {
 	/**
 	 * Data provider.
 	 *
-	 * @return array
+	 * @return array<string, array<string, string>>
 	 */
 	public function dataStubGetBlogInfo() {
 		return [
@@ -125,9 +125,9 @@ public function testStubWpKsesPost() {
 	 *
 	 * @dataProvider dataStubWpParseArgs
 	 *
-	 * @param array $settings Value for settings to pass to the function.
-	 * @param array $defaults Value for defaults to pass to the function.
-	 * @param array $expected Expected return value.
+	 * @param array<string, mixed> $settings Value for settings to pass to the function.
+	 * @param array<string, mixed> $defaults Value for defaults to pass to the function.
+	 * @param array<string, mixed> $expected Expected return value.
 	 *
 	 * @return void
 	 */
@@ -138,7 +138,7 @@ public function testStubWpParseArgs( $settings, $defaults, $expected ) {
 	/**
 	 * Data provider.
 	 *
-	 * @return array
+	 * @return array<string, array<string, array<string, mixed>>>
 	 */
 	public function dataStubWpParseArgs() {
 		return [
@@ -219,7 +219,7 @@ public function testStubWpStripAllTags( $text, $remove_breaks, $expected ) {
 	/**
 	 * Data provider.
 	 *
-	 * @return array
+	 * @return array<string, array<string, string|bool>>
 	 */
 	public function dataStubWpStripAllTags() {
 		return [
@@ -271,7 +271,7 @@ public function dataStubWpStripAllTags() {
 	 *
 	 * @dataProvider dataStubWpSlash
 	 *
-	 * @param string $input Value to pass to the function.
+	 * @param mixed $input Value to pass to the function.
 	 *
 	 * @return void
 	 */
@@ -282,7 +282,7 @@ public function testStubWpSlash( $input ) {
 	/**
 	 * Data provider.
 	 *
-	 * @return array
+	 * @return array<string, array<string, mixed>>
 	 */
 	public function dataStubWpSlash() {
 		return [
@@ -308,8 +308,8 @@ public function dataStubWpSlash() {
 	 *
 	 * @dataProvider dataStubWpUnslash
 	 *
-	 * @param string $input    Value to pass to the function.
-	 * @param string $expected Expected return value.
+	 * @param mixed $input    Value to pass to the function.
+	 * @param mixed $expected Expected return value.
 	 *
 	 * @return void
 	 */
@@ -320,7 +320,7 @@ public function testStubWpUnslash( $input, $expected ) {
 	/**
 	 * Data provider.
 	 *
-	 * @return array
+	 * @return array<string, array<string, mixed>>
 	 */
 	public function dataStubWpUnslash() {
 		return [

diff --git a/tests/Helpers/ExpectOutputHelperTest.php b/tests/Helpers/ExpectOutputHelperTest.php
@@ -123,7 +123,7 @@ public function testMatchingSubstringsWithMismatchedLineEndingsAmount( $expected
 	/**
 	 * Data provider.
 	 *
-	 * @return array
+	 * @return array<array<string>>
 	 */
 	public function dataMatchingSubstringsMismatchedLineEndings() {
 		return [
@@ -231,7 +231,7 @@ public function testNormalizeLineEndings( $input, $expected ) {
 	/**
 	 * Data provider for the `testNormalizeLineEndings()` test.
 	 *
-	 * @return array
+	 * @return array<string, array<string>>
 	 */
 	public function dataNormalizeLineEndings() {
 		return [