Make WordPress Core

Opened 4 weeks ago

Closed 4 weeks ago

#61124 closed enhancement (fixed)

Missing doc comment text

Reported by: yagniksangani's profile yagniksangani Owned by: sergeybiryukov's profile SergeyBiryukov
Milestone: 6.6 Priority: normal
Severity: normal Version:
Component: Upgrade/Install Keywords: has-patch 2nd-opinion
Focuses: docs Cc:

Description

There is missing doc comment text in the file "\wp-admin\includes\class-bulk-plugin-upgrader-skin.php" for function "public function bulk_footer() {" at line number 42.

Attachments (2)

some-feature.61124.diff (1.2 KB) - added by yagniksangani 4 weeks ago.
Added missing doc comments
some-feature.61124.2.diff (4.8 KB) - added by yagniksangani 4 weeks ago.

Download all attachments as: .zip

Change History (7)

@yagniksangani
4 weeks ago

Added missing doc comments

#1 @audrasjb
4 weeks ago

  • Keywords 2nd-opinion added

Thanks for the ticket,

I'm not sure these docblock description suggestions provide enough value as it, but if we want to add these then please note that (at least) the following similar files should also be updated:

  • class-bulk-upgrader-skin.php
  • class-bulk-theme-upgrader-skin.php

#2 @yagniksangani
4 weeks ago

  • Keywords 2nd-opinion removed

Found some more files where missing comments,

\wp-admin\includes\class-bulk-theme-upgrader-skin.php
\wp-admin\includes\class-bulk-upgrader-skin.php
\wp-admin\includes\class-ftp-pure.php
\wp-admin\includes\class-ftp-sockets.php
\wp-admin\includes\class-ftp.php

I think there are many more files where missing doc comments.

#3 @audrasjb
4 weeks ago

  • Keywords 2nd-opinion added

Re-adding 2nd-opinion to gather feedback from other developers since I'm unsure these changes are worth the effort :)

#4 @SergeyBiryukov
4 weeks ago

  • Component changed from General to Upgrade/Install
  • Focuses docs added; coding-standards removed
  • Milestone changed from Awaiting Review to 6.6

#5 @SergeyBiryukov
4 weeks ago

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

In 58082:

Docs: Add missing documentation for various upgrade/install class methods.

Follow-up to [13602], [13686], [14879], [25806], [28495], [32655], [48661], [53952].

Props yagniksangani, audrasjb, SergeyBiryukov.
Fixes #61124.

Note: See TracTickets for help on using tickets.