WordPress.org

Make WordPress Core

Opened 3 months ago

Closed 3 months ago

#49474 closed defect (bug) (fixed)

Add missing quote to @see hook reference in function DocBlock

Reported by: coffee2code Owned by: SergeyBiryukov
Milestone: 5.4 Priority: lowest
Severity: trivial Version: 4.6
Component: Comments Keywords: has-patch
Focuses: docs Cc:

Description

In the DocBlock for wp_transition_comment_status(), the opening single-quote is missing from a @see reference to a hook:

Current:
{@see comment_$old_status_to_$new_status'}

Should be:
{@see 'comment_$old_status_to_$new_status'}

The Code Reference corrects for this, but ideally shouldn't have to.

I've checked and this is the only current instance of this sort of thing.

Patch attached.

Attachments (1)

49474.diff (747 bytes) - added by coffee2code 3 months ago.
Patch mentioned in ticket.

Download all attachments as: .zip

Change History (3)

@coffee2code
3 months ago

Patch mentioned in ticket.

#1 @SergeyBiryukov
3 months ago

  • Milestone changed from Awaiting Review to 5.4
  • Owner set to SergeyBiryukov
  • Status changed from new to reviewing

#2 @SergeyBiryukov
3 months ago

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

In 47324:

Docs: Add missing quote to {@see 'comment_$old_status_to_$new_status'} hook reference in wp_transition_comment_status() DocBlock.

Props coffee2code.
Fixes #49474.

Note: See TracTickets for help on using tickets.