WordPress.org

Make WordPress Core

Opened 7 months ago

Last modified 3 months ago

#39593 new defect (bug)

Improve DocBlocks in class-automatic-upgrader-skin.php

Reported by: carl-alberto Owned by:
Milestone: Future Release Priority: normal
Severity: normal Version:
Component: Upgrade/Install Keywords: has-patch
Focuses: docs Cc:

Description

Missing DocBlock Description and wrong @param formatting in:
wp-admin/includes/class-automatic-upgrader-skin.php
public function feedback( $data )

Attachments (4)

39593.diff (634 bytes) - added by carl-alberto 7 months ago.
39593.2.diff (2.0 KB) - added by carl-alberto 7 months ago.
Another attempt to improve docblock
39593.3.diff (2.4 KB) - added by carl-alberto 7 months ago.
Here's another attempt
39606.patch (422 bytes) - added by mitraval192 7 months ago.
Added Ticket #39606 patch for the @access

Download all attachments as: .zip

Change History (17)

@carl-alberto
7 months ago

#1 @Soean
7 months ago

  • Keywords needs-refresh added
  • Summary changed from Improve DocBlock for function feedback($data) in class-automatic-upgrader-skin.php to Improve DocBlocks in class-automatic-upgrader-skin.php

Hey Carl,
thanks for the patch. As I looked into the Automatic_Upgrader_Skin class, I saw that the
$messages property as well as the methods get_upgrade_messages(), header() and footer() need doc improvements, too. They should also handled by this ticket.

Last edited 7 months ago by Soean (previous) (diff)

@carl-alberto
7 months ago

Another attempt to improve docblock

#2 @carl-alberto
7 months ago

  • Keywords has-patch added

Hi Soean,

Thanks for the advice. sent another diff file to include the DocBlock improvement of:
$messages
get_upgrade_messages()
header()
footer()

Thanks!

#3 @SergeyBiryukov
7 months ago

  • Keywords needs-refresh removed
  • Milestone changed from Awaiting Review to 4.8

#4 @Soean
7 months ago

#39606 was marked as a duplicate.

#5 @SergeyBiryukov
7 months ago

  • Keywords needs-refresh added

Needs a refresh to include 39606.patch:ticket:39606.

@carl-alberto
7 months ago

Here's another attempt

#6 @carl-alberto
7 months ago

  • Keywords needs-refresh removed

@mitraval192
7 months ago

Added Ticket #39606 patch for the @access

#7 @Soean
7 months ago

The other WP_Upgrader_Skin classes also have incomplete DocBlocks:

  • WP_Upgrader_Skin
  • Bulk_Plugin_Upgrader_Skin
  • Bulk_Theme_Upgrader_Skin
  • Bulk_Upgrader_Skin
  • Language_Pack_Upgrader_Skin
  • Plugin_Installer_Skin
  • Plugin_Upgrader_Skin
  • Theme_Installer_Skin
  • Theme_Upgrader_Skin

#8 follow-up: @carl-alberto
7 months ago

Hi @Soean,

Do we tackle all the patches thru this ticket or separate tickets per file that don't have proper DocBlocks?

Thanks!

#9 in reply to: ↑ 8 @SergeyBiryukov
7 months ago

Replying to carl-alberto:

Do we tackle all the patches thru this ticket or separate tickets per file that don't have proper DocBlocks?

Let's create a separate ticket per file.

#10 @carl-alberto
7 months ago

Alright @SergeyBiryukov thanks!

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


3 months ago

#12 @ocean90
3 months ago

  • Version trunk deleted

#13 @ocean90
3 months ago

  • Milestone changed from 4.8 to Future Release
Note: See TracTickets for help on using tickets.