[wp-trac] [WordPress Trac] #55645: Docs: Improve the documentation for `plugins_api()`.

[WordPress Trac]

#55645: Docs: Improve the documentation for `plugins_api()`.
----------------------------+---------------------
 Reporter:  costdev         |       Owner:  (none)
     Type:  task (blessed)  |      Status:  new
 Priority:  normal          |   Milestone:  6.0
Component:  Plugins         |     Version:  2.7
 Severity:  normal          |  Resolution:
 Keywords:  needs-patch     |     Focuses:  docs
----------------------------+---------------------
Description changed by costdev:

Old description:

> The docblock for `plugins_api()` needs some improvement, including:
>
> - it does not document the make-up of possible return values.
> - it has several self-references.
>
> Related ticket: #55480

New description:

 The docblock for
 [https://developer.wordpress.org/reference/functions/plugins_api/
 plugins_api()] needs some improvement, including:

 - it does not document the make-up of possible return values.
 - it has a self-reference in the `@return` annotation.

 Related ticket: #55480

--

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