WordPress.org
Get WordPress

Make WordPress Core

Opened 11 months ago

Closed 10 months ago

#63356 closed enhancement (fixed)

Remove redundant abstract tags from DocBlocks

Reported by: marian1's profile marian1 Owned by: sergeybiryukov's profile SergeyBiryukov
Milestone: 6.9 Priority: normal
Severity: trivial Version:
Component: General Keywords: has-patch
Focuses: docs Cc:

Description

A number of methods of WP_Image_Editor include an @abstract tag in their DocBlocks, even though it is already declared in the function signature. These tags are redundant and add no new information.

I propose removing these tags to reduce redundancy.

Change History (5)

This ticket was mentioned in ​PR #8744 on ​WordPress/wordpress-develop by ​@marian1.
11 months ago #1

  • Keywords has-patch added

This patch removes @abstract tags from DocBlocks when it is already defined in the method declaration. In such cases, the tags are redundant and do not provide additional value.

Trac ticket: https://core.trac.wordpress.org/ticket/63356

​@narenin commented on ​PR #8744:
11 months ago #2

Thanks for the patch @IanDelMar this looks good to me.

​@ankitmaru commented on ​PR #8744:
11 months ago #3

@IanDelMar Nice fix. ✅ Looks good to me. Great work.

#4 @SergeyBiryukov
10 months ago

  • Milestone changed from Awaiting Review to 6.9

#5 @SergeyBiryukov
10 months ago

  • Owner set to SergeyBiryukov
  • Resolution set to fixed
  • Status changed from new to closed

In 60198:

Docs: Remove redundant @abstract tags from DocBlocks in WP_Image_Editor.

Since the affected methods are already marked as abstract in the function signature, these tags are unnecessary and add no new information.

Follow-up to [22094], [22510], [22619].

Props marian1, narenin, ankitmaru.
Fixes #63356.

Note: See TracTickets for help on using tickets.