[wp-trac] [WordPress Trac] #48932: Docs: Missing inline documentation for wp_dashboard_browser_nag()

WordPress Trac noreply at wordpress.org
Wed Dec 11 07:53:16 UTC 2019


#48932: Docs: Missing inline documentation for wp_dashboard_browser_nag()
----------------------------+-----------------------------
 Reporter:  grapplerulrich  |      Owner:  (none)
     Type:  defect (bug)    |     Status:  new
 Priority:  normal          |  Milestone:  Awaiting Review
Component:  Administration  |    Version:  3.2
 Severity:  normal          |   Keywords:
  Focuses:  docs            |
----------------------------+-----------------------------
 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/

 {{{#!php
 // Display Browser Nag Meta Box
 function wp_dashboard_browser_nag() {
 }}}

 My suggestion for the inline block would be:
 {{{#!php
 /**
  * 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() {
 }}}

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/48932>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list