[wp-trac] [WordPress Trac] #42786: get_settings_errors() inline docs return should reflect the array in detail

[WordPress Trac]

#42786: get_settings_errors() inline docs return should reflect the array in detail
----------------------------+-----------------------------
 Reporter:  webdevmattcrom  |      Owner:
     Type:  defect (bug)    |     Status:  new
 Priority:  normal          |  Milestone:  Awaiting Review
Component:  General         |    Version:  trunk
 Severity:  normal          |   Keywords:
  Focuses:                  |
----------------------------+-----------------------------
 The return array should be explained in better detail in the inline docs,
 both for the purpose of clarity for developers, and for DevHub purposes.

 Here's the line in the code:
 https://core.trac.wordpress.org/browser/tags/4.9/src/wp-
 admin/includes/template.php#L1440

 Suggested return array:


 {{{
 @return array {
  *     @type string $setting    The setting that is throwing an error.
  *     @type string $code       Code of the error.
  *     @type string $message    Message of the error.
  *     @type string $type       Type of error.
  * }
 }}}

 I have a patch, but would like clarity on whether this is accurate first.

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