WordPress.org

Make WordPress Core

Opened 3 years ago

Closed 11 months ago

#44453 closed defect (bug) (duplicate)

PHPDoc comments do not contain all necessary @throws tags

Reported by: subrataemfluence Owned by:
Milestone: Priority: normal
Severity: normal Version: 5.1
Component: General Keywords:
Focuses: docs, coding-standards Cc:

Description

Files:

/wp-includes/functions.php
/wp-includes/spl-autoload-compat.php

There are more files having this issue but I am not sure if they are extensively maintained by WordPress core team itself. One example is files inside pomo directory. So I did not consider them.

Please find attached proposed patch.

Attachments (1)

44453.diff (1.2 KB) - added by subrataemfluence 3 years ago.
Proposed patch

Download all attachments as: .zip

Change History (3)

@subrataemfluence
3 years ago

Proposed patch

#1 @netweb
3 years ago

  • Milestone changed from Awaiting Review to Future Release

You are correct @subrataemfluence, there has not been much usage of @throws historically, it is also not documented in the handbook.

A little more research and some documentation is probably required in order before landing this.

#2 @SergeyBiryukov
11 months ago

  • Keywords needs-patch removed
  • Milestone Future Release deleted
  • Resolution set to duplicate
  • Status changed from new to closed

Thanks for the patch!

Just noting that spl-autoload-compat.php was deprecated in [45637] / #46630.

The instance in _wp_json_sanity_check() was addressed in [47427] / #45643.

Note: See TracTickets for help on using tickets.