Make WordPress Core

Opened 2 years ago

Closed 2 years ago

#57723 closed enhancement (fixed)

Fix Test Class Header Tags in Few More Files

Reported by: fuadragib's profile fuadragib Owned by: sergeybiryukov's profile SergeyBiryukov
Milestone: 6.2 Priority: normal
Severity: normal Version:
Component: Build/Test Tools Keywords: has-patch
Focuses: Cc:

Description

I'm creating this ticket following this ticket as few more files have the same duplicate header tags.

Check this comment: https://core.trac.wordpress.org/ticket/57099#comment:11

Attachments (1)

57723.diff (28.7 KB) - added by sakibmd 2 years ago.
This ticket addresses doc block changes only. I have already solved lots of files & can't find anymore from my side.

Download all attachments as: .zip

Change History (10)

@sakibmd
2 years ago

This ticket addresses doc block changes only. I have already solved lots of files & can't find anymore from my side.

#1 @sakibmd
2 years ago

  • Keywords has-patch added; needs-patch removed

#2 @SergeyBiryukov
2 years ago

  • Milestone changed from Awaiting Review to 6.2

#3 @naeemhaque
2 years ago

Thank You @sakibmd for this patch file. There are a lot of file changes.
Checked these files, and everything looks better.

#4 @seakashdiu
2 years ago

Thanks, @fuadragib for figuring it out. I checked the patch https://core.trac.wordpress.org/attachment/ticket/57723/57723.diff and it looks ok to me. Thanks, @sakibmd for adding more files.

#5 @jakariaistauk
2 years ago

Test Report

This report validates that the indicated patch addresses the issue.
Patch tested: https://core.trac.wordpress.org/attachment/ticket/57723/57723.diff

Environment

  • OS: macOS 13.0
  • Web Server: nginx/1.23.1
  • PHP: 7.4.30
  • WordPress: 6.2-beta2-55340-src
  • Browser: Google Chrome Version 109.0.5414.119
  • Theme: Twenty Twenty-Three

Actual Results

  • ✅ Issue resolved with patch.

#6 @hasanmisbah
2 years ago

thanks, @sakibmd your PR looks good. and thanks @fuadragib for figuring it out.

This ticket was mentioned in Slack in #core by costdev. View the logs.


2 years ago

#8 @SergeyBiryukov
2 years ago

  • Owner set to SergeyBiryukov
  • Status changed from new to accepted

#9 @SergeyBiryukov
2 years ago

  • Resolution set to fixed
  • Status changed from accepted to closed

In 55457:

Tests: Second pass at merging file-level and class-level DocBlocks in various unit test files.

Per thedocumentation 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.

Note: See TracTickets for help on using tickets.