[wp-trac] [WordPress Trac] #56164: Create a way to reference function parameter documentation when complex parameters are passed to hooks
WordPress Trac
noreply at wordpress.org
Wed Jul 6 17:28:42 UTC 2022
#56164: Create a way to reference function parameter documentation when complex
parameters are passed to hooks
-------------------------+------------------------------
Reporter: desrosj | Owner: (none)
Type: enhancement | Status: new
Priority: normal | Milestone: Awaiting Review
Component: General | Version:
Severity: normal | Resolution:
Keywords: 2nd-opinion | Focuses: docs
-------------------------+------------------------------
Comment (by desrosj):
I thought of this while creating a patch to add a filter for #34669.
The `$args` parameter there is documented in detail at the beginning of
the function above. The idea was also inspired by comment:6:ticket:53946,
which encourages a more consistent way to document the a return type when
multiple types are possible and the type will match the one passed to the
function.
--
Ticket URL: <https://core.trac.wordpress.org/ticket/56164#comment:1>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list