WordPress.org

Make WordPress Core

Opened 3 months ago

Last modified 3 months ago

#48349 new defect (bug)

Requests::request_multiple() should have the option documentation in phpDoc

Reported by: marekdedic Owned by:
Milestone: 5.4 Priority: normal
Severity: minor Version: 5.2
Component: HTTP API Keywords: good-first-bug has-patch
Focuses: docs Cc:
PR Number:

Description

Currently, the $options argument field is documented in the description:

https://developer.wordpress.org/reference/classes/requests/request_multiple/

I believe it could be documented using phpDoc directly like

@param array $options {
    Description.

    @type ...
}

Attachments (2)

48349.patch (5.0 KB) - added by hogetan 3 months ago.
Fix option description
48349.2.patch (5.0 KB) - added by hogetan 3 months ago.
Remove debug code

Download all attachments as: .zip

Change History (7)

#1 @marekdedic
3 months ago

Also, I believe the return value could be narrowed from array to Requests_Response[]|Requests_Exception[].

#2 @johnbillion
3 months ago

  • Keywords needs-patch good-first-bug added

#3 @desrosj
3 months ago

  • Milestone changed from Awaiting Review to 5.4

#4 @SergeyBiryukov
3 months ago

  • Component changed from General to HTTP API

@hogetan
3 months ago

Fix option description

@hogetan
3 months ago

Remove debug code

#5 @spenserhale
3 months ago

  • Keywords has-patch added; needs-patch removed
Last edited 3 months ago by spenserhale (previous) (diff)
Note: See TracTickets for help on using tickets.