[wp-trac] [WordPress Trac] #55646: Docblock improvements for 6.1

[WordPress Trac]

#55646: Docblock improvements for 6.1
----------------------------+---------------------
 Reporter:  costdev         |       Owner:  (none)
     Type:  task (blessed)  |      Status:  new
 Priority:  normal          |   Milestone:  6.1
Component:  General         |     Version:
 Severity:  normal          |  Resolution:
 Keywords:  has-patch       |     Focuses:  docs
----------------------------+---------------------

Comment (by SergeyBiryukov):

 In [changeset:"54157" 54157]:
 {{{
 #!CommitTicketReference repository="" revision="54157"
 Docs: Correct `@return` value for `wp_get_http_headers()`.

 Following the update to replace the HTTP API internals with Requests
 library in WordPress 4.6, the return value of
 `wp_remote_retrieve_headers()` has changed from a simple array to an
 object which implements `ArrayAccess`.

 Since `wp_get_http_headers()` directly returns the result of
 `wp_remote_retrieve_headers()`, its return value should reflect that
 change.

 Includes:
 * Updating the return value for the deprecated `wp_get_http()` function,
 which also directly returns the result of `wp_remote_retrieve_headers()`.
 * Minor DocBlock formatting changes for some other HTTP API functions per
 the documentation standards.

 Follow-up to [2416], [6390], [8092], [9013], [37428], [37989], [38730].

 Props mhkuu.
 See #54225, #55646.
 }}}

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/55646#comment:105>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform