WordPress.org

Make WordPress Core

Opened 5 months ago

Closed 4 months ago

#47104 closed defect (bug) (fixed)

Fix incorrect @see notation in the DocBlock for wp_localize_script()

Reported by: coffee2code Owned by: SergeyBiryukov
Milestone: 5.3 Priority: low
Severity: trivial Version:
Component: Script Loader Keywords: has-patch commit
Focuses: docs Cc:

Description

The function wp_localize_script() defines a @see reference in its DocBlock as such:

* @see WP_Dependencies::localize()

That referenced method has since apparently been moved into another class, so the line should be changed to:

* @see WP_Scripts::localize()

This was originally reported by @shamim51 in #meta4416 because the @see caused DevHub to generate a link to a nonexistent method (see the link in question, though it may get corrected manually on DevHub at some point)`.

Patch attached.

Attachments (1)

47104.diff (495 bytes) - added by coffee2code 5 months ago.
Patch mentioned in ticket.

Download all attachments as: .zip

Change History (3)

@coffee2code
5 months ago

Patch mentioned in ticket.

#1 @SergeyBiryukov
4 months ago

  • Component changed from General to Script Loader
  • Keywords commit added
  • Milestone changed from Awaiting Review to 5.3
  • Owner set to SergeyBiryukov
  • Status changed from new to reviewing

#2 @SergeyBiryukov
4 months ago

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

In 45392:

Docs: Fix incorrect @see notation in wp_localize_script() DocBlock.

Props coffee2code, shamim51.
Fixes #47104.

Note: See TracTickets for help on using tickets.