WordPress.org

Make WordPress Core

Opened 5 years ago

Closed 5 years ago

#31842 closed defect (bug) (invalid)

Fix inline document: put the html in the variable before passing to the filter.

Reported by: ShinichiN Owned by:
Milestone: Priority: normal
Severity: normal Version: 3.7
Component: General Keywords:
Focuses: docs Cc:

Description

I think the author of this inline document forgot to replace the html with the variable he/she described in the document.

Attachments (2)

31842.diff (924 bytes) - added by ShinichiN 5 years ago.
31842-2.diff (686 bytes) - added by ShinichiN 5 years ago.
First patch was an mistake..

Download all attachments as: .zip

Change History (5)

@ShinichiN
5 years ago

@ShinichiN
5 years ago

First patch was an mistake..

#1 @DrewAPicture
5 years ago

  • Keywords close added
  • Version changed from trunk to 3.7

The filter line has been that way since [25570] when the title attribute was removed. The code wsan't changed when the hook doc was added in [27676], and I'm not sure why the locale code additions are needed.

As for the string passed to the filter, it doesn't need to match the variable used in the DocBlock, that's there for documentation purposes only.

#2 @SergeyBiryukov
5 years ago

This looks fine to me as is. As noted above, the string does not need to match the variable in the docs.

If we decide to fix it, the variable should be assigned before the DocBlock, not after.

#3 @DrewAPicture
5 years ago

  • Keywords close removed
  • Milestone Awaiting Review deleted
  • Resolution set to invalid
  • Status changed from new to closed
Note: See TracTickets for help on using tickets.