WordPress / WordPress/Requests
Requests::request_multiple() should have the option documentation in phpDoc
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 3.6k
- Forks
- 500
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 5
Description
From https://core.trac.wordpress.org/ticket/48349:
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 ...
}
Patch at https://core.trac.wordpress.org/attachment/ticket/48349/48349.2.patch
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the Requests::request_multiple() method and inspect its current $options documentation, using the linked developer reference for context. Update the phpDoc to describe the option structure directly, then verify that the generated reference documentation still presents the options correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100