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

Open
#435 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
50/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
php
Domain
documentation

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.

Description

Type: documentation

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

Dominant language
PHP
Stars
3.6k
Forks
500
Avg merge
2d 21h
Merged PRs (30d)
5

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from WordPress/Requests

All issues in WordPress/Requests

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.