Skip to content

Commit b0f085e

Browse files
Tests: Second pass at merging file-level and class-level DocBlocks in various unit test files.
Per the[https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#6-file-headers documentation standards], whenever possible, all WordPress files should contain a header DocBlock, regardless of the file’s contents – this includes files containing classes. However, this recommendation makes less sense for unit test classes if not applied consistently, and the duplicate tags cause some confusion. This commit aims to reduce confusion and avoid repeating information by combining the DocBlocks. Follow-up to [55337]. Props sakibmd, fuadragib, robinwpdeveloper, naeemhaque, seakashdiu, jakariaistauk, hasanmisbah, SergeyBiryukov. Fixes #57723. git-svn-id: https://develop.svn.wordpress.org/trunk@55457 602fd350-edb4-49c9-b593-d223f7449a82
1 parent 6a574d7 commit b0f085e

73 files changed

Lines changed: 82 additions & 363 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

tests/phpunit/tests/block-supports/layout.php

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
11
<?php
22
/**
3-
* Block supports tests for the layout.
3+
* Tests for block supports related to layout.
44
*
55
* @package WordPress
66
* @subpackage Block Supports
77
* @since 6.0.0
8-
*/
9-
10-
/**
11-
* Tests for block supports related to layout.
12-
*
13-
* @since 6.0.0
148
*
159
* @group block-supports
1610
*

tests/phpunit/tests/block-template-utils.php

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
<?php
22
/**
3-
* Tests_Block_Template_Utils class
3+
* Tests for the Block Templates abstraction layer.
44
*
55
* @package WordPress
6-
*/
7-
8-
/**
9-
* Tests for the Block Templates abstraction layer.
106
*
117
* @group block-templates
128
*/

tests/phpunit/tests/block-template.php

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
<?php
22
/**
3-
* Tests_Block_Template class
3+
* Tests for the block template loading algorithm.
44
*
55
* @package WordPress
6-
*/
7-
8-
/**
9-
* Tests for the block template loading algorithm.
106
*
117
* @group block-templates
128
*/

tests/phpunit/tests/blocks/context.php

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
11
<?php
22
/**
3-
* Block context tests
3+
* Tests for block context functions.
44
*
55
* @package WordPress
66
* @subpackage Blocks
77
* @since 5.5.0
8-
*/
9-
10-
/**
11-
* Tests for block context functions.
12-
*
13-
* @since 5.5.0
148
*
159
* @group blocks
1610
*/

tests/phpunit/tests/blocks/editor.php

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
11
<?php
22
/**
3-
* Block editor tests
3+
* Tests for the block editor methods.
44
*
55
* @package WordPress
66
* @subpackage Blocks
77
* @since 5.5.0
8-
*/
9-
10-
/**
11-
* Tests for the block editor methods.
12-
*
13-
* @since 5.5.0
148
*
159
* @group blocks
1610
*/

tests/phpunit/tests/blocks/register.php

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
11
<?php
22
/**
3-
* Block registration tests
3+
* Tests for register_block_type(), unregister_block_type(), get_dynamic_block_names(), and register_block_style().
44
*
55
* @package WordPress
66
* @subpackage Blocks
77
* @since 5.0.0
8-
*/
9-
10-
/**
11-
* Tests for register_block_type(), unregister_block_type(), get_dynamic_block_names(), and register_block_style().
12-
*
13-
* @since 5.0.0
148
*
159
* @group blocks
1610
*/

tests/phpunit/tests/blocks/render.php

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
11
<?php
22
/**
3-
* Block rendering tests
3+
* Tests for block rendering functions.
44
*
55
* @package WordPress
66
* @subpackage Blocks
77
* @since 5.0.0
8-
*/
9-
10-
/**
11-
* Tests for block rendering functions.
12-
*
13-
* @since 5.0.0
148
*
159
* @group blocks
1610
*/

tests/phpunit/tests/blocks/renderCommentTemplate.php

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
11
<?php
22
/**
3-
* Comment Template block rendering tests.
3+
* Tests for the Comment Template block rendering.
44
*
55
* @package WordPress
66
* @subpackage Blocks
77
* @since 6.0.0
8-
*/
9-
10-
/**
11-
* Tests for the Comment Template block.
12-
*
13-
* @since 6.0.0
148
*
159
* @group blocks
1610
*/

tests/phpunit/tests/blocks/renderReusable.php

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
11
<?php
22
/**
3-
* Reusable block rendering tests
3+
* Tests for reusable block rendering.
44
*
55
* @package WordPress
66
* @subpackage Blocks
77
* @since 5.0.0
8-
*/
9-
10-
/**
11-
* Tests for reusable block rendering.
12-
*
13-
* @since 5.0.0
148
*
159
* @group blocks
1610
*/

tests/phpunit/tests/blocks/serialize.php

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
11
<?php
22
/**
3-
* Block serialization tests
3+
* Tests for block serialization functions.
44
*
55
* @package WordPress
66
* @subpackage Blocks
7-
* @since 5.3.3
8-
*/
9-
10-
/**
11-
* Tests for block serialization functions.
127
*
138
* @since 5.3.3
149
*

0 commit comments

Comments
 (0)