WordPress.org

Make WordPress Core

Opened 10 months ago

Last modified 5 months ago

#48349 new defect (bug)

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

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

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 9 months ago.
Fix option description
48349.2.patch (5.0 KB) - added by hogetan 9 months ago.
Remove debug code

Download all attachments as: .zip

Change History (9)

#1 @marekdedic
10 months ago

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

#2 @johnbillion
10 months ago

  • Keywords needs-patch good-first-bug added

#3 @desrosj
10 months ago

  • Milestone changed from Awaiting Review to 5.4

#4 @SergeyBiryukov
10 months ago

  • Component changed from General to HTTP API

@hogetan
9 months ago

Fix option description

@hogetan
9 months ago

Remove debug code

#5 @spenserhale
9 months ago

  • Keywords has-patch added; needs-patch removed
Last edited 9 months ago by spenserhale (previous) (diff)

#6 @dd32
6 months ago

As the Requests class is an external project, https://developer.wordpress.org/reference/classes/requests/ probably shouldn't even exist, and documentation improvements should probably be discussed on it's Github project page.

#7 @adamsilverstein
5 months ago

  • Milestone changed from 5.4 to Future Release

I agree, it seems like the doc changes should be proposed and made upstream in the Requests project. Once we get changes merged there we can follow up to upgrade the core bundled version. Otherwise, if we make these changes only locally in WordPress core, they would get overwritten if/when we update the Requests version we bundle.

I searched through the open issues and didn't find anything about the documenting the option array there. It would be great to start by opening an issue describing the change. I believe there may be other opportunities to improve inline docs, especially arrays, elsewhere in the project.

Marking this ticket as future release for now, until we get the changes merged upstream.

Note: See TracTickets for help on using tickets.