WordPress.org

Make WordPress Core

Opened 7 months ago

Closed 7 months ago

#51448 closed defect (bug) (fixed)

Add missing @return tag to Language_Pack_Upgrader::check_package()

Reported by: ankitmaru Owned by: SergeyBiryukov
Milestone: 5.6 Priority: normal
Severity: minor Version: 3.7
Component: Upgrade/Install Keywords: has-patch needs-refresh
Focuses: docs Cc:

Description

Missing @return tag in function/method PHPDoc comment

Attachments (2)

class-language-pack-upgrader.php.patch (519 bytes) - added by ankitmaru 7 months ago.
51448.patch (682 bytes) - added by ankitmaru 7 months ago.

Download all attachments as: .zip

Change History (9)

#1 @mukesh27
7 months ago

  • Focuses docs added
  • Summary changed from Coding Standards / Doc Comments fixe to Coding Standards / Doc Comments fix

#2 @mukesh27
7 months ago

  • Keywords needs-refresh added

Please update return type with below description.

* @return string|WP_Error The source or a WP_Error.

@ankitmaru
7 months ago

#3 @ankitmaru
7 months ago

@mukesh27 Thanks, I have updated the patch.

#4 @mukesh27
7 months ago

  • Keywords needs-refresh removed

Thanks for update.

Patch looks fine for me.

#5 @desrosj
7 months ago

  • Component changed from General to Upgrade/Install
  • Focuses coding-standards removed
  • Keywords needs-refresh added
  • Milestone changed from Awaiting Review to Future Release
  • Severity changed from normal to minor
  • Version changed from trunk to 3.7

Can we also update the function's @param tags to include descriptions?

Also, since this file is only ~500 lines, it would be great to audit the inline documentation for the entire file at the same time. At first glance, it looks like most of the functions have all of the required inline docs, but if it could be double checked, that would be great!

#6 @SergeyBiryukov
7 months ago

  • Milestone changed from Future Release to 5.6
  • Owner set to SergeyBiryukov
  • Status changed from new to reviewing
  • Summary changed from Coding Standards / Doc Comments fix to Add missing @return tag to Language_Pack_Upgrader::check_package()

#7 @SergeyBiryukov
7 months ago

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

In 49091:

Docs: Add missing @return tag to Language_Pack_Upgrader::check_package().

Synchronize documentation of the ::check_package() method between Plugin_Upgrader, Theme_Upgrader, and Language_Pack_Upgrader.

Props ankitmaru, mukesh27, desrosj.
Fixes #51448.

Note: See TracTickets for help on using tickets.