Make WordPress Core

Opened 2 years ago

Closed 2 years ago

#61124 closed enhancement (fixed)

Missing doc comment text

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

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 2 years ago.
Added missing doc comments
some-feature.61124.2.diff​ (4.8 KB ) - added by yagniksangani 2 years ago.

Download all attachments as: .zip

Change History (7)

@yagniksangani
2 years ago

Added missing doc comments

#1 @audrasjb
2 years 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
2 years 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
2 years 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
2 years ago

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

#5 @SergeyBiryukov
2 years ago

  • Owner set to SergeyBiryukov
  • Resolution → fixed
  • Status new → 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.