WordPress.org

Make WordPress Core

Opened 3 months ago

Closed 3 months ago

#48932 closed defect (bug) (fixed)

Docs: Missing inline documentation for wp_dashboard_browser_nag()

Reported by: grapplerulrich Owned by: SergeyBiryukov
Milestone: 5.4 Priority: normal
Severity: normal Version: 3.2
Component: Administration Keywords:
Focuses: docs Cc:

Description

The function wp_dashboard_browser_nag() has only a single line inline documentation. It is missing the version it was added and the the return parameter.

https://developer.wordpress.org/reference/functions/wp_dashboard_browser_nag/

// Display Browser Nag Meta Box
function wp_dashboard_browser_nag() {

My suggestion for the inline block would be:

/**
 * Display Browser Nag Meta Box.
 *
 * @since 3.2.0
 *
 * @return string The notice output for the 'Browse Happy' nag meta box.
 */
function wp_dashboard_browser_nag() {

Attachments (1)

48932.diff (526 bytes) - added by grapplerulrich 3 months ago.

Download all attachments as: .zip

Change History (3)

#1 @SergeyBiryukov
3 months ago

  • Milestone changed from Awaiting Review to 5.4

#2 @SergeyBiryukov
3 months ago

  • Owner set to SergeyBiryukov
  • Resolution set to fixed
  • Status changed from new to closed

In 46880:

Docs: Improve documentation for wp_dashboard_browser_nag() and dashboard_browser_nag_class().

Props grapplerulrich.
Fixes #48932.

Note: See TracTickets for help on using tickets.