[wp-trac] [WordPress Trac] #40839: Incorrect and incomplete inline docs for wp_check_browser_version()

[WordPress Trac]

#40839: Incorrect and incomplete inline docs for wp_check_browser_version()
--------------------------+-----------------------------
 Reporter:  coffee2code   |      Owner:
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  Awaiting Review
Component:  General       |    Version:
 Severity:  trivial       |   Keywords:  has-patch
  Focuses:  docs          |
--------------------------+-----------------------------
 The inline docs for `wp_check_browser_version()` in `wp-
 admin/includes/dashboard.php` incorrectly states that the response array
 from the BrowseHappy API will include the `upgrade_url` key. In reality,
 the name for the key is `update_url`. (The correct key name is used in the
 actual code.)

 See
 https://meta.trac.wordpress.org/browser/sites/trunk/api.wordpress.org/public_html/core
 /browse-happy/1.0/parse.php#L83

 Additionally, the API may return a `platform` key and value, which isn't
 mentioned in the inline docs.

 The attached patch corrects the misnamed response key and adds docs for
 the missing key.

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