Skip to content

Docs: Align @param tag columns in phpunit/ docblocks #13414

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mukeshpanchal27 wants to merge 2 commits into from
Closed

Docs: Align @param tag columns in phpunit/ docblocks #13414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5cd066
Docs: Align param tag columns in phpunit/ docblocks
mukeshpanchal27 Sep 7, 2026
ec800a9
Docs: Align remaining PHPUnit @param tag columns.
t-hamano Sep 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions tests/phpunit/tests/block-supports/layout.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -757,8 +757,8 @@ public function data_wp_add_parent_layout_to_parsed_block() {
*
* @covers ::wp_render_layout_support_flag
*
* @param array $block_attrs Dataset to test.
* @param array $expected_class Class generated for the passed dataset.
* @param array $block_attrs Dataset to test.
* @param array $expected_class Class generated for the passed dataset.
*/
public function test_layout_support_flag_renders_consistent_container_hash( $block_attrs, $expected_class ) {
switch_theme( 'default' );
Expand Down
6 changes: 3 additions & 3 deletions tests/phpunit/tests/block-supports/shadow.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ private function register_shadow_block_with_support( $block_name, $supports = ar
*
* @dataProvider data_generate_shadow_fixtures
*
* @param boolean|array $support Shadow block support configuration.
* @param string $value Shadow style value for style attribute object.
* @param array $expected Expected shadow block support styles.
* @param boolean|array $support Shadow block support configuration.
* @param string $value Shadow style value for style attribute object.
* @param array $expected Expected shadow block support styles.
*/
public function test_wp_apply_shadow_support( $support, $value, $expected ) {
$block_type = self::register_shadow_block_with_support(
Expand Down
4 changes: 2 additions & 2 deletions tests/phpunit/tests/block-supports/states.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ private function ensure_block_registered( $block_name, $selectors = array(), $su
* to produce the unique scoped class name for a given map of state => style arrays.
* CSS is now registered with the style engine store rather than injected inline.
*
* @param array $state_styles Map of state to style array (e.g. `[':hover' => ['color' => [...]]]`).
* @param string $block_name Block name.
* @param array $state_styles Map of state to style array (e.g. `[':hover' => ['color' => [...]]]`).
* @param string $block_name Block name.
* @return array { unique_class: string }
*/
private function build_expected_state_output( $state_styles, $block_name = 'core/button' ) {
Expand Down
12 changes: 6 additions & 6 deletions tests/phpunit/tests/block-supports/typography.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ public function test_should_generate_classname_for_font_family() {
* @type string $size CSS font-size value, including units where applicable.
* }
* @param bool $settings Theme JSON settings array that overrides any global theme settings.
* @param string $expected_output Expected output.
* @param string $expected_output Expected output.
*/
public function test_wp_get_typography_font_size_value( $font_size_preset, $settings, $expected_output ) {
$actual = wp_get_typography_font_size_value( $font_size_preset, $settings );
Expand Down Expand Up @@ -820,15 +820,15 @@ public function data_generate_font_size_preset_fixtures() {
*
* @dataProvider data_generate_font_size_preset_should_use_fluid_typography_deprecated_fixtures
*
* @param array $font_size {
* @param array $font_size {
* Required. A font size as represented in the fontSizes preset format as seen in theme.json.
*
* @type string $name Name of the font size preset.
* @type string $slug Kebab-case unique identifier for the font size preset.
* @type string $size CSS font-size value, including units where applicable.
* }
* @param bool $should_use_fluid_typography An override to switch fluid typography "on". Can be used for unit testing.
* @param string $expected_output Expected output of wp_get_typography_font_size_value().
* @param string $expected_output Expected output of wp_get_typography_font_size_value().
*/
public function test_wp_get_typography_font_size_value_should_use_fluid_typography_deprecated( $font_size, $should_use_fluid_typography, $expected_output ) {
$actual = wp_get_typography_font_size_value( $font_size, $should_use_fluid_typography );
Expand Down Expand Up @@ -870,7 +870,7 @@ public function data_generate_font_size_preset_should_use_fluid_typography_depre
*
* @dataProvider data_generate_should_override_theme_settings_fixtures
*
* @param array $font_size {
* @param array $font_size {
* Required. A font size as represented in the fontSizes preset format as seen in theme.json.
*
* @type string $name Name of the font size preset.
Expand Down Expand Up @@ -1339,7 +1339,7 @@ public function data_invalid_size_wp_get_typography_value_and_unit() {
*
* @dataProvider data_wp_get_computed_fluid_typography_value
*
* @param array $args {
* @param array $args {
* Optional. An associative array of values to calculate a fluid formula for font size. Default is empty array.
*
* @type string $maximum_viewport_width Maximum size up to which type will have fluidity.
Expand All @@ -1348,7 +1348,7 @@ public function data_invalid_size_wp_get_typography_value_and_unit() {
* @type string $minimum_font_size Minimum font size for any clamp() calculation.
* @type int $scale_factor A scale factor to determine how fast a font scales within boundaries.
* }
* @param string $expected_output Expected value of style property from wp_apply_typography_support().
* @param string $expected_output Expected value of style property from wp_apply_typography_support().
*/
public function test_wp_get_computed_fluid_typography_value( $args, $expected_output ) {
$actual = wp_get_computed_fluid_typography_value( $args );
Expand Down
4 changes: 2 additions & 2 deletions tests/phpunit/tests/theme/wpThemeJson.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7608,8 +7608,8 @@ public function test_resolve_variables() {
*
* @dataProvider data_get_block_style_variation_selector
*
* @param string $selector CSS selector.
* @param string $expected Expected block style variation CSS selector.
* @param string $selector CSS selector.
* @param string $expected Expected block style variation CSS selector.
*/
public function test_get_block_style_variation_selector( $selector, $expected ) {
$theme_json = new ReflectionClass( 'WP_Theme_JSON' );
Expand Down
4 changes: 2 additions & 2 deletions tests/phpunit/tests/theme/wpThemeJsonSelectorList.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class Tests_Theme_wpThemeJsonSelectorList extends WP_UnitTestCase {
* Invokes a protected static method on WP_Theme_JSON.
*
* @param string $method_name Method name.
* @param mixed ...$args Method arguments.
* @param mixed ...$args Method arguments.
* @return mixed Method result.
*/
private static function invoke_theme_json_method( $method_name, ...$args ) {
Expand All @@ -32,7 +32,7 @@ private static function invoke_theme_json_method( $method_name, ...$args ) {
/**
* @dataProvider data_split_selector_list
*
* @param string $selector CSS selector list.
* @param string $selector CSS selector list.
* @param string[] $expected Expected selectors.
*/
public function test_split_selector_list( $selector, $expected ) {
Expand Down
Loading